ncdisp

Display contents of NetCDF data source in Command Window

Syntax

ncdisp(source)

ncdisp(source,location)

ncdisp(source,location,dispFormat)

Description

ncdisp(source) displays all groups, dimensions, variable definitions, and attributes in the NetCDF data source, source, as text in the Command Window.

ncdisp(source,location) displays information about the variable or group specified by location.

ncdisp(source,location,dispFormat) displays the contents of the NetCDF data source in the display format specified by dispFormat.

Examples

Display Contents of NetCDF File

Display the contents of the example NetCDF file, example.nc.

ncdisp('example.nc')

Source:
           matlabroot\toolbox\matlab\demos\example.nc
Format:
           netcdf4
Global Attributes:
           creation_date = '29-Mar-2010'
Dimensions:
           x = 50
           y = 50
           z = 5
Variables:
    avagadros_number
           Size:       1x1
           Dimensions: 
           Datatype:   double
           Attributes:
                       description = 'this variable has no dimensions'
    temperature     
           Size:       50x1
           Dimensions: x
           Datatype:   int16
           Attributes:
                       scale_factor = 1.8
                       add_offset   = 32
                       units        = 'degrees_fahrenheight'
    peaks           
           Size:       50x50
           Dimensions: x,y
           Datatype:   int16
           Attributes:
                       description = 'z = peaks(50);'
Groups:
    /grid1/
        Attributes:
                   description = 'This is a group attribute.'
        Dimensions:
                   x    = 360
                   y    = 180
                   time = 0     (UNLIMITED)
        Variables:
            temp
                   Size:       []
                   Dimensions: x,y,time
                   Datatype:   int16
    
    /grid2/
        Attributes:
                   description = 'This is another group attribute.'
        Dimensions:
                   x    = 360
                   y    = 180
                   time = 0     (UNLIMITED)
        Variables:
            temp
                   Size:       []
                   Dimensions: x,y,time
                   Datatype:   int16

MATLAB^® displays all the groups, dimensions, and variable definitions in example.nc.

Display Contents of NetCDF Variable

Display the contents of the variable peaks in the file, example.nc.

ncdisp('example.nc','peaks')

Source:
           matlabroot\toolbox\matlab\demos\example.nc
Format:
           netcdf4
Dimensions:
           x = 50
           y = 50
Variables:
    peaks
           Size:       50x50
           Dimensions: x,y
           Datatype:   int16
           Attributes:
                       description = 'z = peaks(50);'

Display Contents of NetCDF File and Hide Attributes

Display only the group hierarchy and variable definitions of the example file, example.nc.

ncdisp('example.nc','/','min')

Source:
           matlabroot\toolbox\matlab\demos\example.nc
Format:
           netcdf4
Variables:
    avagadros_number
           Size:       1x1
           Dimensions: 
           Datatype:   double
    temperature     
           Size:       50x1
           Dimensions: x
           Datatype:   int16
    peaks           
           Size:       50x50
           Dimensions: x,y
           Datatype:   int16
Groups:
    /grid1/
        Variables:
            temp
                   Size:       []
                   Dimensions: x,y,time
                   Datatype:   int16
    
    /grid2/
        Variables:
            temp
                   Size:       []
                   Dimensions: x,y,time
                   Datatype:   int16

Input Arguments

source — Source name

character vector | string scalar

Source name, specified as a character vector or string scalar containing the name of a NetCDF file, the URL of an OPeNDAP NetCDF data source, or an HTTP URL of a remote NetCDF file for byte-range reading. To enable byte-range reading of remote datasets, append #mode=bytes to the end of the HTTP URL. For details about byte-range reading, consult the NetCDF documentation.

Example: "myNetCDFfile.nc"

Data Types: char | string

location — Location of variable or group

'/' (default) | character vector | string scalar

Location of a variable or group in the NetCDF file, specified as a character vector or string scalar. Set location to '/'(forward slash) to display the entire contents of the file.

Data Types: char | string

dispFormat — Display format

'full' (default) | 'min'

Display format, specified as one of these values.

'full'	Display group hierarchy with dimensions, attributes, and variable definitions
'min'	Display group hierarchy and variable definitions

Data Types: char | string

Limitations

• The performance of byte-range reading is slower than reading from other sources.

Tips

• If source is an OPeNDAP URL with a constraint expression, use the syntax ncdisp(source) with no other input arguments.

Version History

Introduced in R2011a