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

输入参数

全部折叠

`source` — netCDF 数据源的名称
字符串标量 | 字符向量

netCDF 数据源的名称，指定为字符串标量或字符向量。source 参量可以是以下值之一：

本地 netCDF 源的路径
远程 OPeNDAP netCDF 数据源的 OPeNDAP URL
远程 netCDF 源的 HTTP URL，在 URL 的末尾附加 #mode=bytes 以支持字节范围读取
注意
字节范围读取比从其他来源读取要慢。有关字节范围读取的更多详细信息，请参阅 netCDF 文档。

示例: "myNetCDFfile.nc"

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

`varname` — 变量名称
字符串标量 | 字符向量

变量名称，指定为包含 netCDF 数据源中变量名称的字符串标量或字符向量。

如果 source 指定格式为 netcdf4 的文件，您可以通过将 varname 指定为完全限定名称来指定变量在组层次结构中的位置。

示例: "myVar"

示例: "/myGrp/mySubGrp/myNestedVar"

`groupname` — 组名称
字符串标量 | 字符向量

组名称，指定为包含 netCDF 数据源中组名称的字符串标量或字符向量。

示例: "myGrp"

示例: "/myGrp/mySubGrp"

输出参量

全部折叠

`finfo` — NetCDF 文件架构
结构体

NetCDF 文件架构，以结构体形式返回。下表描述了结构体的字段。

字段	描述
`Filename`	NetCDF 文件名或 OPeNDAP URL，以字符向量形式返回
`Name`	`'/'`（指示完整文件）
`Dimensions`	维度架构，以包含以下字段的结构体向量形式返回： `Name` - 维度的名称，以字符向量形式返回 `Length` - 维度的长度，以非负整数形式返回（值 `0` 表示无限维度） `Unlimited` - 维度是否无限，以逻辑标量形式返回
`Variables`	变量架构，与 `vinfo` 输出参量中所述的架构相同，但没有 `Filename` 和 `Format` 字段
`Attributes`	属性架构，以包含以下字段的结构体向量形式返回： `Name` - 属性的名称，以字符向量形式返回 `Value` - 属性的值
`Groups`	组架构，与 `ginfo` 输出参量中所述的架构相同，但没有 `Filename` 和 `Format` 字段；如果文件格式不是 `netcdf4`，则为空数组 (`[]`)
`Format`	NetCDF 文件格式，以字符向量形式返回
`Datatypes`	用户定义的数据类型组成的结构体向量，包含以下字段（如果没有用户定义的数据类型，则为空数组 (`[]`)）： `Name` - 数据类型的名称，以字符向量形式返回 `Class` — `'NC_VLEN'` `Type` - 数据类型的 MATLAB^® 类型，以字符向量形式返回 `ByteSize` - 以字节为单位的类型大小，以正整数形式返回

`vinfo` — NetCDF 变量架构
结构体

NetCDF 变量架构，以结构体形式返回。下表描述了结构体的字段。

字段	描述
`Filename`	NetCDF 文件名或 OPeNDAP URL，以字符向量形式返回
`Name`	变量的名称，以字符向量形式返回
`Dimensions`	变量的维度架构，以包含以下字段的结构体向量形式返回： `Name` - 维度的名称，以字符向量形式返回 `Length` - 维度的长度，以非负整数形式返回（值 `0` 表示无限维度） `Unlimited` - 维度是否无限，以逻辑标量形式返回
`Size`	当前变量的大小，以数值标量或向量形式返回
`Datatype`	变量的 MATLAB 数据类型或用户定义的类型的名称，以字符向量形式返回
`Attributes`	变量的属性架构，以包含以下字段的结构体向量形式返回： `Name` - 属性的名称，以字符向量形式返回 `Value` - 属性的值
`ChunkSize`	变量的块大小，如果已定义，则以数值形式返回；否则，为空数组 (`[]`)
`FillValue`	变量的填充值，如果已定义，则以标量形式返回；否则，为空数组 (`[]`)
`DeflateLevel`	变量的 Deflate 压缩级别，如果启用，则以非负整数形式返回；否则，为空数组 (`[]`)
`Shuffle`	是否为变量启用 shuffle 过滤器，以逻辑标量形式返回
`Format`	NetCDF 文件格式，以字符向量形式返回

`ginfo` — NetCDF 组架构
结构体

NetCDF 组架构，以结构体形式返回。下表描述了结构体的字段。

字段	描述
`Filename`	NetCDF 文件名或 OPeNDAP URL，以字符向量形式返回
`Name`	组的名称，以字符向量形式返回
`Dimensions`	组的维度架构，以包含以下字段的结构体向量形式返回： `Name` - 维度的名称，以字符向量形式返回 `Length` - 维度的长度，以非负整数形式返回（值 `0` 表示无限维度） `Unlimited` - 维度是否无限，以逻辑标量形式返回
`Variables`	组的变量架构，与 `vinfo` 输出参量中所述的架构相同，但没有 `Filename` 和 `Format` 字段
`Attributes`	组的属性架构，以包含以下字段的结构体向量形式返回： `Name` - 属性的名称，以字符向量形式返回 `Value` - 属性的值
`Groups`	组的组架构，与此输出参量中所述的架构相同，但没有 `Filename` 和 `Format` 字段
`Format`	NetCDF 文件格式，以字符向量形式返回