Netcdfreadr: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Scott
(Created page with "===Purpose=== Reads in netCDF files and outputs a DataSet and or structure. ===Synopsis=== :x = netcdfreadr(filenames, options); ===Description=== If no file is given (fi...")
 
imported>Scott
Line 30: Line 30:
''options'' =  a structure array with the following fields:
''options'' =  a structure array with the following fields:


* '''nonmatching''': [ 'error' | {'cell'} ], defines action taken when the x-axes or data types of multiple spectra being read do not match. The default choice, 'cell', returns a cell array where each element is a dataset object with data from a single file.  The other choice, 'error', will return an error when the files do not match.
* '''output''' :[{'dso'}|'rawdata'|'datastruct'|'all'] What output to pass.
 
* '''getms''' : [{'yes'}|'no'] Get Mass Spec dataset from file.
* '''multiselect''' : [ 'off' | {'on'} ] governs whether file selection dialog should allow multiple files to be selected and imported. Setting to 'off' will restrict user to importing only one file at a time.
* '''massoffset''' : [0] Shift point for round-off (when using .getms).
* '''chunksize''' : [1.5] Divide data into chunks of chunksize*1,000,000 elements when contructing a MS dataset. Value of 1.5 million is good default for 32bit systems.


===See Also===
===See Also===

Revision as of 14:26, 27 October 2014

Purpose

Reads in netCDF files and outputs a DataSet and or structure.

Synopsis

x = netcdfreadr(filenames, options);

Description

If no file is given (filenames) then prompts user for filename/s. Default options are set to handle Mass Spectroscopy exported data.

NOTE: This function uses netcnetCDF Library Functions available in Matlab 2009a and newer.

Inputs

  • filename = a text string with the name of a spectral file or a cell of strings of filenames.
    • If filename is omitted or blank, the user will be prompted to select a file graphically.
    • If filename is an empty cell {}, the user will be prompted to select a folder and then one or more AIT files in the identified folder.

Outputs

  • x = takes one of two forms:
  1. If input is a single file, or multiple files containing data that can be combined (same number of data points, same x-axis range, same type of data), the output is a dataset object
  2. If the input consists of multiple files, but the data cannot be combined, the output is a cell array with a dataset object for each input file (see the nonmatching option defined above)

Options

options = a structure array with the following fields:

  • output :[{'dso'}|'rawdata'|'datastruct'|'all'] What output to pass.
  • getms : [{'yes'}|'no'] Get Mass Spec dataset from file.
  • massoffset : [0] Shift point for round-off (when using .getms).
  • chunksize : [1.5] Divide data into chunks of chunksize*1,000,000 elements when contructing a MS dataset. Value of 1.5 million is good default for 32bit systems.

See Also

Data Importing Formats, asdreadr, asfreadr, fluoromaxreadr, gwscanreadr, hjyreadr, jcampreadr, opusreadr, pdfreadr, pereadr, spareadr, spcreadr, writeasf, xclreadr