octave_packages/octcdf-1.1.4/doc-cache

   1 # Created by Octave 3.6.1, Thu Apr 26 22:44:40 2012 UTC <root@t61>
   2 # name: cache
   3 # type: cell
   4 # rows: 3
   5 # columns: 12
   6 # name: <cell-element>
   7 # type: sq_string
   8 # elements: 1
   9 # length: 14
  10 example_netcdf
  11
  12
  13 # name: <cell-element>
  14 # type: sq_string
  15 # elements: 1
  16 # length: 48
  17  Example for creating and reading a netcdf file
  18
  19
  20
  21 # name: <cell-element>
  22 # type: sq_string
  23 # elements: 1
  24 # length: 48
  25  Example for creating and reading a netcdf file
  26
  27
  28
  29
  30 # name: <cell-element>
  31 # type: sq_string
  32 # elements: 1
  33 # length: 15
  34 example_opendap
  35
  36
  37 # name: <cell-element>
  38 # type: sq_string
  39 # elements: 1
  40 # length: 54
  41  Example for loading a dataset from an OPeNDAP server
  42
  43
  44
  45 # name: <cell-element>
  46 # type: sq_string
  47 # elements: 1
  48 # length: 54
  49  Example for loading a dataset from an OPeNDAP server
  50
  51
  52
  53
  54 # name: <cell-element>
  55 # type: sq_string
  56 # elements: 1
  57 # length: 6
  58 ncbyte
  59
  60
  61 # name: <cell-element>
  62 # type: sq_string
  63 # elements: 1
  64 # length: 578
  65  -- Loadable Function: NCVAR =  ncbyte(DIMNAME_1,...,DIMNAME_N)
  66      creates a netcdf variable of type ncbyte. DIMNAME_1 is the name of
  67      the 1st netcdf dimension, and so on. The return value is a netcdf
  68      variable object and must be affected to a netcdf file, before its
  69      content can be defined.
  70
  71      Example:
  72           nc = netcdf('test.nc','w');
  73           nc('lon') = 360;
  74           nc('lat') = 180;
  75           nc{'var'} =  ncbyte('lon','lat');
  76      A new 360 by 180 netcdf variable named 'var' of type byte is
  77      created in file 'test.nc'.
  78
  79    See also: netcdf
  80
  81
  82
  83
  84 # name: <cell-element>
  85 # type: sq_string
  86 # elements: 1
  87 # length: 41
  88 creates a netcdf variable of type ncbyte.
  89
  90
  91
  92 # name: <cell-element>
  93 # type: sq_string
  94 # elements: 1
  95 # length: 6
  96 ncchar
  97
  98
  99 # name: <cell-element>
 100 # type: sq_string
 101 # elements: 1
 102 # length: 578
 103  -- Loadable Function: NCVAR =  ncchar(DIMNAME_1,...,DIMNAME_N)
 104      creates a netcdf variable of type ncchar. DIMNAME_1 is the name of
 105      the 1st netcdf dimension, and so on. The return value is a netcdf
 106      variable object and must be affected to a netcdf file, before its
 107      content can be defined.
 108
 109      Example:
 110           nc = netcdf('test.nc','w');
 111           nc('lon') = 360;
 112           nc('lat') = 180;
 113           nc{'var'} =  ncchar('lon','lat');
 114      A new 360 by 180 netcdf variable named 'var' of type char is
 115      created in file 'test.nc'.
 116
 117    See also: netcdf
 118
 119
 120
 121
 122 # name: <cell-element>
 123 # type: sq_string
 124 # elements: 1
 125 # length: 41
 126 creates a netcdf variable of type ncchar.
 127
 128
 129
 130 # name: <cell-element>
 131 # type: sq_string
 132 # elements: 1
 133 # length: 8
 134 ncdouble
 135
 136
 137 # name: <cell-element>
 138 # type: sq_string
 139 # elements: 1
 140 # length: 586
 141  -- Loadable Function: NCVAR =  ncdouble(DIMNAME_1,...,DIMNAME_N)
 142      creates a netcdf variable of type ncdouble. DIMNAME_1 is the name
 143      of the 1st netcdf dimension, and so on. The return value is a
 144      netcdf variable object and must be affected to a netcdf file,
 145      before its content can be defined.
 146
 147      Example:
 148           nc = netcdf('test.nc','w');
 149           nc('lon') = 360;
 150           nc('lat') = 180;
 151           nc{'var'} =  ncdouble('lon','lat');
 152      A new 360 by 180 netcdf variable named 'var' of type double is
 153      created in file 'test.nc'.
 154
 155    See also: netcdf
 156
 157
 158
 159
 160 # name: <cell-element>
 161 # type: sq_string
 162 # elements: 1
 163 # length: 43
 164 creates a netcdf variable of type ncdouble.
 165
 166
 167
 168 # name: <cell-element>
 169 # type: sq_string
 170 # elements: 1
 171 # length: 6
 172 ncdump
 173
 174
 175 # name: <cell-element>
 176 # type: sq_string
 177 # elements: 1
 178 # length: 530
 179  -- Loadable Function: ncdump (FILENAME)
 180  -- Loadable Function: ncdump (FILENAME,OUTPUT_FILENAME)
 181      This function writes the content of the NetCDF file FILENAME
 182      except the actual values of the variables to the screen or to the
 183      file OUTPUT_FILENAME is this argument is provided.  The output
 184      used the same syntax that the octcdf toolbox. Therefore ncdump can
 185      be used to create a program that produces a NetCDF file with the
 186      same metadata than the NetCDF file FILENAME.
 187
 188    See also: ncdim, ncvar, ncatt
 189
 190
 191
 192
 193 # name: <cell-element>
 194 # type: sq_string
 195 # elements: 1
 196 # length: 80
 197 This function writes the content of the NetCDF file FILENAME except the
 198 actual v
 199
 200
 201
 202 # name: <cell-element>
 203 # type: sq_string
 204 # elements: 1
 205 # length: 9
 206 ncfillval
 207
 208
 209 # name: <cell-element>
 210 # type: sq_string
 211 # elements: 1
 212 # length: 192
 213  -- Loadable Function: FILLVALUE =  ncfillval (NCVAR)
 214  -- Loadable Function: ncfillval (NCVAR,FILLVALUE)
 215      returns or sets the FILLVALUE of the NetCDF variable NCVAR.
 216
 217    See also: netcdf
 218
 219
 220
 221
 222 # name: <cell-element>
 223 # type: sq_string
 224 # elements: 1
 225 # length: 59
 226 returns or sets the FILLVALUE of the NetCDF variable NCVAR.
 227
 228
 229
 230 # name: <cell-element>
 231 # type: sq_string
 232 # elements: 1
 233 # length: 7
 234 ncfloat
 235
 236
 237 # name: <cell-element>
 238 # type: sq_string
 239 # elements: 1
 240 # length: 582
 241  -- Loadable Function: NCVAR =  ncfloat(DIMNAME_1,...,DIMNAME_N)
 242      creates a netcdf variable of type ncfloat. DIMNAME_1 is the name
 243      of the 1st netcdf dimension, and so on. The return value is a
 244      netcdf variable object and must be affected to a netcdf file,
 245      before its content can be defined.
 246
 247      Example:
 248           nc = netcdf('test.nc','w');
 249           nc('lon') = 360;
 250           nc('lat') = 180;
 251           nc{'var'} =  ncfloat('lon','lat');
 252      A new 360 by 180 netcdf variable named 'var' of type float is
 253      created in file 'test.nc'.
 254
 255    See also: netcdf
 256
 257
 258
 259
 260 # name: <cell-element>
 261 # type: sq_string
 262 # elements: 1
 263 # length: 42
 264 creates a netcdf variable of type ncfloat.
 265
 266
 267
 268 # name: <cell-element>
 269 # type: sq_string
 270 # elements: 1
 271 # length: 5
 272 ncint
 273
 274
 275 # name: <cell-element>
 276 # type: sq_string
 277 # elements: 1
 278 # length: 574
 279  -- Loadable Function: NCVAR =  ncint(DIMNAME_1,...,DIMNAME_N)
 280      creates a netcdf variable of type ncint. DIMNAME_1 is the name of
 281      the 1st netcdf dimension, and so on. The return value is a netcdf
 282      variable object and must be affected to a netcdf file, before its
 283      content can be defined.
 284
 285      Example:
 286           nc = netcdf('test.nc','w');
 287           nc('lon') = 360;
 288           nc('lat') = 180;
 289           nc{'var'} =  ncint('lon','lat');
 290      A new 360 by 180 netcdf variable named 'var' of type int is
 291      created in file 'test.nc'.
 292
 293    See also: netcdf
 294
 295
 296
 297
 298 # name: <cell-element>
 299 # type: sq_string
 300 # elements: 1
 301 # length: 40
 302 creates a netcdf variable of type ncint.
 303
 304
 305
 306 # name: <cell-element>
 307 # type: sq_string
 308 # elements: 1
 309 # length: 6
 310 nclong
 311
 312
 313 # name: <cell-element>
 314 # type: sq_string
 315 # elements: 1
 316 # length: 578
 317  -- Loadable Function: NCVAR =  nclong(DIMNAME_1,...,DIMNAME_N)
 318      creates a netcdf variable of type nclong. DIMNAME_1 is the name of
 319      the 1st netcdf dimension, and so on. The return value is a netcdf
 320      variable object and must be affected to a netcdf file, before its
 321      content can be defined.
 322
 323      Example:
 324           nc = netcdf('test.nc','w');
 325           nc('lon') = 360;
 326           nc('lat') = 180;
 327           nc{'var'} =  nclong('lon','lat');
 328      A new 360 by 180 netcdf variable named 'var' of type long is
 329      created in file 'test.nc'.
 330
 331    See also: netcdf
 332
 333
 334
 335
 336 # name: <cell-element>
 337 # type: sq_string
 338 # elements: 1
 339 # length: 41
 340 creates a netcdf variable of type nclong.
 341
 342
 343
 344 # name: <cell-element>
 345 # type: sq_string
 346 # elements: 1
 347 # length: 7
 348 ncshort
 349
 350
 351 # name: <cell-element>
 352 # type: sq_string
 353 # elements: 1
 354 # length: 582
 355  -- Loadable Function: NCVAR =  ncshort(DIMNAME_1,...,DIMNAME_N)
 356      creates a netcdf variable of type ncshort. DIMNAME_1 is the name
 357      of the 1st netcdf dimension, and so on. The return value is a
 358      netcdf variable object and must be affected to a netcdf file,
 359      before its content can be defined.
 360
 361      Example:
 362           nc = netcdf('test.nc','w');
 363           nc('lon') = 360;
 364           nc('lat') = 180;
 365           nc{'var'} =  ncshort('lon','lat');
 366      A new 360 by 180 netcdf variable named 'var' of type short is
 367      created in file 'test.nc'.
 368
 369    See also: netcdf
 370
 371
 372
 373
 374 # name: <cell-element>
 375 # type: sq_string
 376 # elements: 1
 377 # length: 42
 378 creates a netcdf variable of type ncshort.
 379
 380
 381
 382 # name: <cell-element>
 383 # type: sq_string
 384 # elements: 1
 385 # length: 6
 386 nctest
 387
 388
 389 # name: <cell-element>
 390 # type: sq_string
 391 # elements: 1
 392 # length: 131
 393  -- Loadable Function: nctest
 394      Tests the octcdf toolbox. Tests results are written to nctest.log.
 395      All tests should pass.
 396
 397
 398
 399
 400 # name: <cell-element>
 401 # type: sq_string
 402 # elements: 1
 403 # length: 25
 404 Tests the octcdf toolbox.
 405
 406
 407
 408
 409