Jcampreadr: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Scott
No edit summary
imported>Jeremy
No edit summary
Line 5: Line 5:
===Synopsis===
===Synopsis===


:data = jcampreadr('filename.dx')
:data = jcampreadr('filename.dx',''options'')


===Description===
===Description===
Line 15: Line 15:
LINK
LINK


Output (data) is a DataSet object containing the spectrum or spectra from the file (or an empty array if no data could be read).
This importer adapted with permission from original code by Prof. Paul Gemperline at Eastern Carolina University. (gemperlinep@mail.ecu.edu)
 
====Optional Inputs====
*'''fname''' = specifies the file(s) to read using:
::'''(a)''' a string specifying a single file to read
::'''(b)''' a cell array of strings specifying multiple files to read
::'''(c)''' the output of the MATLAB "dir" command specifying multiple files to read
:If fname is an empty string or matrix or is not supplied, the user is prompted to identify file(s) to load.
*'''options''' = an optional options structure. See Options below.
               
====Outputs====
*'''data''' = a DataSet object containing the spectrum or spectra from the file (or an empty array if no data could be read)  
*'''wrn''' = a cell array of warnings issued during the reading of the file.
 
===Options===
Input 'options' is an options structure containing the following fields
*'''display''': <tt>[{'off'}| 'on' ]</tt> Governs display to the command line. Warnings encountered during file load will be supressed if display is 'off'.
*'''waitbar''': <tt>[ 'off' |{'on'}]</tt> Governs display of a progress bar when doing multiple file reading.


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


[[spcreadr]], [[xclreadr]]
[[spcreadr]], [[xclreadr]]

Revision as of 10:30, 29 October 2008

Purpose

Reads a JCAMP file into a DataSet object.

Synopsis

data = jcampreadr('filename.dx',options)

Description

Input is the filename of a JCAMP file to read. If omitted, the user is prompted for a file. Currently this reader will only read files of type:

INFRARED SPECTRUM

LINK

This importer adapted with permission from original code by Prof. Paul Gemperline at Eastern Carolina University. (gemperlinep@mail.ecu.edu)

Optional Inputs

  • fname = specifies the file(s) to read using:
(a) a string specifying a single file to read
(b) a cell array of strings specifying multiple files to read
(c) the output of the MATLAB "dir" command specifying multiple files to read
If fname is an empty string or matrix or is not supplied, the user is prompted to identify file(s) to load.
  • options = an optional options structure. See Options below.

Outputs

  • data = a DataSet object containing the spectrum or spectra from the file (or an empty array if no data could be read)
  • wrn = a cell array of warnings issued during the reading of the file.

Options

Input 'options' is an options structure containing the following fields

  • display: [{'off'}| 'on' ] Governs display to the command line. Warnings encountered during file load will be supressed if display is 'off'.
  • waitbar: [ 'off' |{'on'}] Governs display of a progress bar when doing multiple file reading.

See Also

spcreadr, xclreadr