Asfreadr: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Scott
imported>Donal
No edit summary
Line 1: Line 1:
===Purpose===
===Purpose===


Reads a Hamilton Sundstrand data file.
Reads an AIT data file.


===Synopsis===
===Synopsis===
Line 9: Line 9:
===Description===
===Description===


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


====Inputs====
====Inputs====
Line 17: Line 17:
*  '''If''' filename is omitted or blank, the user will be prompted to select a file graphically.
*  '''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 Hamilton Sundstrand files in the identified folder.
*  '''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====
====Outputs====

Revision as of 10:33, 26 April 2012

Purpose

Reads an AIT data file.

Synopsis

x = asfreadr(filename,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 = 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.


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

asdreadr, asfreadr, editds, hjyreadr, jcampreadr, pdfreadr, spareadr, spcreadr, writeasf, xclreadr