ncinfo

netCDF データ ソースに関する情報を返す

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

    構文

    finfo = ncinfo(source)
    vinfo = ncinfo(source,varname)
    ginfo = ncinfo(source,groupname)

    説明

    finfo = ncinfo(source) は、source で指定された netCDF データ ソース全体に関する情報を返します。

    例

    vinfo = ncinfo(source,varname) は、source 内の変数 varname に関する情報を返します。

    例

    ginfo = ncinfo(source,groupname) は、source 内のグループ groupname に関する情報を返します。

    例

    例

    すべて折りたたむ

    netCDF ファイル example.nc のファイル スキーマを取得します。

    finfo = ncinfo("example.nc")
    finfo = 

  struct with fields:

      Filename: 'matlabroot\toolbox\matlab\demos\example.nc'
          Name: '/'
    Dimensions: [1×3 struct]
     Variables: [1×3 struct]
    Attributes: [1×1 struct]
        Groups: [1×2 struct]
        Format: 'netcdf4'
     Datatypes: []

    名前が x で始まる次元を検索します。

    dimNames = {finfo.Dimensions.Name};
dimMatch = strncmpi(dimNames,"x",1);
disp(finfo.Dimensions(dimMatch))
             Name: 'x'
       Length: 50
    Unlimited: 0

    netCDF ファイル example.nc 内の peaks 変数の変数スキーマを取得します。

    vinfo = ncinfo("example.nc","peaks")
    vinfo = 

  struct with fields:

        Filename: 'matlabroot\toolbox\matlab\demos\example.nc'
            Name: 'peaks'
      Dimensions: [1×2 struct]
            Size: [50 50]
        Datatype: 'int16'
      Attributes: [1×1 struct]
       ChunkSize: []
       FillValue: -32767
    DeflateLevel: []
         Shuffle: 0
          Format: 'netcdf4'

    peaks 変数のサイズを調べます。

    varSize = vinfo.Size
    varSize =

    50    50

    peaks 変数に制限のない次元があるかどうかを調べます。

    hasUnlimDim = any([vinfo.Dimensions.Unlimited])
    hasUnlimDim =

  logical

   0

    netCDF ファイル example.nc 内の /grid2 グループのグループ スキーマを取得します。

    ginfo = ncinfo("example.nc","/grid2")
    ginfo = 

  struct with fields:

      Filename: 'matlabroot\toolbox\matlab\demos\example.nc'
          Name: 'grid2'
    Dimensions: [1×3 struct]
     Variables: [1×1 struct]
    Attributes: [1×1 struct]
        Groups: []
        Format: 'netcdf4'

    グループ内の制限のない次元を検索します。

    unlimDims = [ginfo.Dimensions.Unlimited];
disp(ginfo.Dimensions(unlimDims))
             Name: 'time'
       Length: 0
    Unlimited: 1

    入力引数

    すべて折りたたむ

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

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

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

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

      メモ

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

    例: "myNetCDFfile.nc"

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

    変数名。netCDF データ ソース内の変数名を含む string スカラーまたは文字ベクトルとして指定します。

    source で netcdf4 形式のファイルを指定した場合、varname を完全修飾名として指定することで、グループ階層内の変数の位置を指定できます。

    例: "myVar"

    例: "/myGrp/mySubGrp/myNestedVar"

    グループ名。netCDF データ ソース内のグループの名前を含む string スカラーまたは文字ベクトルとして指定します。

    例: "myGrp"

    例: "/myGrp/mySubGrp"

    出力引数

    すべて折りたたむ

    NetCDF ファイル スキーマ。構造体として返されます。次の表に、構造体のフィールドを示します。

    フィールド説明
    FilenameNetCDF ファイル名または OPeNDAP URL。文字ベクトルとして返されます。
    Name'/' (ファイル全体を示す)
    Dimensions

    次元スキーマ。次のフィールドを含む構造体ベクトルとして返されます。

    • Name — 次元の名前 (文字ベクトルとして返される)

    • Length — 次元の長さ (非負の整数として返され、値 0 は制限のない次元を表す)

    • Unlimited — 制限のない次元かどうか (logical スカラーとして返される)

    Variables変数スキーマ。出力引数 vinfo で説明しているフィールドのうち、Filename と Format を除くフィールドが含まれます。
    Attributes

    属性スキーマ。次のフィールドを含む構造体ベクトルとして返されます。

    • Name — 属性の名前 (文字ベクトルとして返される)

    • Value — 属性の値

    Groupsグループ スキーマ。出力引数 ginfo で説明しているフィールドのうち、Filename と Format を除くフィールドが含まれます。ファイルが netcdf4 形式でない場合は空の配列 ([]) になります。
    FormatNetCDF ファイル形式。文字ベクトルとして返されます。
    Datatypes

    ユーザー定義のデータ型の次のフィールドを含む構造体ベクトル。ユーザー定義のデータ型がない場合は空の配列 ([]) になります。

    • Name — データ型の名前 (文字ベクトルとして返される)

    • Class — 'NC_VLEN'

    • Type — データ型の MATLAB® 型 (文字ベクトルとして返される)

    • ByteSize — 型のバイト単位のサイズ (正の整数として返される)

    NetCDF 変数スキーマ。構造体として返されます。次の表に、構造体のフィールドを示します。

    フィールド説明
    FilenameNetCDF ファイル名または OPeNDAP URL。文字ベクトルとして返されます。
    Name変数の名前。文字ベクトルとして返されます。
    Dimensions

    変数の次元スキーマ。次のフィールドを含む構造体ベクトルとして返されます。

    • Name — 次元の名前 (文字ベクトルとして返される)

    • Length — 次元の長さ (非負の整数として返され、値 0 は制限のない次元を表す)

    • Unlimited — 制限のない次元かどうか (logical スカラーとして返される)

    Size現在の変数のサイズ。数値スカラーまたはベクトルとして返されます。
    Datatype変数の MATLAB データ型、またはユーザー定義の型の名前。文字ベクトルとして返されます。
    Attributes

    変数の属性スキーマ。次のフィールドを含む構造体ベクトルとして返されます。

    • Name — 属性の名前 (文字ベクトルとして返される)

    • Value — 属性の値

    ChunkSize変数のチャンク サイズ。数値として返されます。定義されていない場合は空の配列 ([]) になります。
    FillValue変数の埋め込み値。スカラーとして返されます。定義されていない場合は空の配列 ([]) になります。
    DeflateLevel変数の deflate 圧縮レベル。非負の整数として返されます。有効になっていない場合は空の配列 ([]) になります。
    Shuffle変数でシャッフル フィルターが有効であるかどうか。logical スカラーとして返されます。
    FormatNetCDF ファイル形式。文字ベクトルとして返されます。

    NetCDF グループ スキーマ。構造体として返されます。次の表に、構造体のフィールドを示します。

    フィールド説明
    FilenameNetCDF ファイル名または OPeNDAP URL。文字ベクトルとして返されます。
    Nameグループの名前。文字ベクトルとして返されます。
    Dimensions

    グループの次元スキーマ。次のフィールドを含む構造体ベクトルとして返されます。

    • Name — 次元の名前 (文字ベクトルとして返される)

    • Length — 次元の長さ (非負の整数として返され、値 0 は制限のない次元を表す)

    • Unlimited — 制限のない次元かどうか (logical スカラーとして返される)

    Variablesグループの変数スキーマ。出力引数 vinfo で説明しているフィールドのうち、Filename と Format を除くフィールドが含まれます。
    Attributes

    グループの属性スキーマ。次のフィールドを含む構造体ベクトルとして返されます。

    • Name — 属性の名前 (文字ベクトルとして返される)

    • Value — 属性の値

    Groupsグループのグループ スキーマ。この出力引数で説明しているフィールドのうち、Filename と Format を除くフィールドが含まれます。
    FormatNetCDF ファイル形式。文字ベクトルとして返されます。

    ヒント

    • netCDF ソースの視覚検査については ncdisp を使用します。

    バージョン履歴

    R2011a で導入

    すべて展開する

    参考

    | | |

    トピック