netcdf.open

netCDF データ ソースを開く

ページ内をすべて折りたたむ

構文

ncid = netcdf.open(source)
ncid = netcdf.open(source,mode)
[actualChunksize,ncid] = netcdf.open(source,mode,chunksize)

説明

ncid = netcdf.open(source) は source を読み取り専用アクセスで開き、netCDF 識別子を ncid に返します。指定された source は、netCDF ファイルの名前、OPeNDAP netCDF データ ソースの URL、またはリモート netCDF ファイルの HTTP URL (バイト範囲読み取り用の #mode=bytes 接尾辞を含む) となります。

例

ncid = netcdf.open(source,mode) は、mode で指定されたアクセスのタイプで source を開きます。モード値は 'WRITE'、'SHARE'、または 'NOWRITE' です。

例

[actualChunksize,ncid] = netcdf.open(source,mode,chunksize) は、既存の netCDF データ ソースを指定した chunksize で開きます。chunksize パラメーターにより、I/O 性能を調整できます。

例

すべて折りたたむ

ライブ スクリプトを開く

サンプルの NetCDF ファイル example.nc を読み取り専用アクセスで開き、変数を読み取り、その後ファイルを閉じます。netcdf.open はファイル識別子を返します。

ncid = netcdf.open('example.nc')
ncid = 
65536

関数 netcdf.getVar を使用して、サンプル ファイル内の変数 avagadros_number に関連付けられたデータを読み取ります。関数 netcdf.getVar の 2 番目の入力は変数 ID であり、変数を識別するための 0 ベースのインデックスです。変数 avagadros_number のインデックス値は 0 です。

A_number = netcdf.getVar(ncid,0)
A_number = 
6.0221e+23

NetCDF ファイルを閉じます。

netcdf.close(ncid)
ライブ スクリプトを開く

NetCDF ファイルを開いて変数に値を代入したうえで、その変数を表示します。

変数 pi が格納された NetCDF ファイル myexample.nc を作成します。

nccreate('myexample.nc','pi')

このファイルを書き込み用に開き、値 3.1416 を変数 pi に書き込みます。

ncid = netcdf.open('myexample.nc','WRITE')
ncid = 65536

varInd = 0; % index of the first variable in the file
varValue = 3.1416; 
netcdf.putVar(ncid,varInd,varValue);

このファイルから変数 pi の値を読み取り、表示します。 

netcdf.getVar(ncid,varInd)
ans = 3.1416

ファイルを閉じます。

netcdf.close(ncid);

入力引数

すべて折りたたむ

netCDF データ ソースの名前。string スカラーまたは文字ベクトルとして指定します。引数 source には、次の値のいずれかを指定できます。

  • ローカルの netCDF ソースのパス

  • リモートの OPeNDAP netCDF データ ソースの OPeNDAP URL

  • リモートの netCDF ソースの HTTP URL。その URL の末尾に #mode=bytes を付け加えてバイト範囲読み取りを有効にする

    メモ

    バイト範囲読み取りは、リモート ソースから読み取る他の方法よりも遅くなります。バイト範囲読み取りの詳細については、netCDF のドキュメンテーションを参照してください。

例: "myNetCDFfile.nc"

例: "http://host_name/netcdf_filename#mode=bytes"

アクセス タイプ。文字ベクトル、string スカラー、または数値として指定します。mode 入力は、次のいずれかの値にできます。

値 説明
'WRITE'読み書き両用
'SHARE'ファイルの同期更新
'NOWRITE'読み取り専用

mode には数値も指定できます。mode の数値は netcdf.getConstant を使用して取得します。たとえば、netcdf.getConstant('WRITE') は mode の数値を返します。いくつかのモードのビット単位の OR を指定するには、これらの数値を使用します。

データ型: char | string | double

性能調整のためのチャンク サイズ パラメーター。整数として指定します。

chunksize パラメーターは、領域と回数の間のトレードオフ、すなわち関数 netcdf.open が netCDF ライブラリ内で確保するメモリに対するシステム呼び出しの回数を制御します。内部要件のため、関数 netcdf.open が実際に使用するチャンク サイズの値は、指定する入力値とは異なる場合があります。この関数が実際に使用する値については、引数 actualChunksize を参照してください。

例: 1024

例: 8192

データ型: double

出力引数

すべて折りたたむ

開いている netCDF ファイルまたは OPeNDAP netCDF データ ソースのファイル識別子。整数として返されます。

データ型: double

関数 netcdf.open が使用する実際のチャンク サイズ。整数として返されます。

データ型: double

アルゴリズム

この関数は、netCDF ライブラリ C API の関数 nc_open および関数 nc__open に相当します。この関数を使用するには、NetCDF プログラミング パラダイムに関する知識が必要です。

バージョン履歴

R2011a で導入

すべて展開する

参考

|