Asfreadr: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
imported>Jeremy
Line 20: Line 20:
====Outputs====
====Outputs====


* '''x''' = a dataset object containing the spectrum.  If multiple files are used for input, the output dataset object will contain the spectral data for each file '''if''' the data types are compatible, the number of points are identical, and the x-axes all match.  Otherwise a cell array of dataset objects or 'error' is returned, depending upon the ''options'' input.
* '''x''' = takes one of two forms:


:# 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
:# 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===

Revision as of 12:58, 24 September 2013

Purpose

Reads an AIT data file.

Synopsis

x = asfreadr(filename,options)
x = asfreadr({'filename' 'filename2'},options)

Description

ASFREADR reads an AIT spectral file (ASF, AIF, and BKH extensions).

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:

  • 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.

See Also

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