Difference between revisions of "Aqualogreadr"

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(See Also)
imported>Benjamin
 
(4 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
===Synopsis===
 
===Synopsis===
  
:out = fluoromaxreadr(file,options);
+
:out = aqualogreadr(file,options);
  
 
====Inputs====
 
====Inputs====
Line 24: Line 24:
  
 
* '''waitbar''' : [ 'off' |{'on'}] Governs use of waitbars to show progress.
 
* '''waitbar''' : [ 'off' |{'on'}] Governs use of waitbars to show progress.
* '''scattercorrection''' : [ 'off' | {'on'}] calls [[flucut]] for Rayleigh correction.
+
* '''scattercorrection''' : [ {'off'} | 'on'] calls [[flucut]] for Rayleigh correction.
 
* '''flucut''' : [[flucut|FLUCUT]] options field for governing calls to [[flucut|FLUCUT]].
 
* '''flucut''' : [[flucut|FLUCUT]] options field for governing calls to [[flucut|FLUCUT]].
* '''LowZero''' : Input (LowZero) to [[flucut|FLUCUT]].
+
** '''LowZero''' : Option (LowZero) for [[flucut|FLUCUT]].
 +
** '''TopZero''' : Option (TopZero) for [[flucut|FLUCUT]].
 
* '''LowMiss''' : Input (LowMiss) to [[flucut|FLUCUT]].
 
* '''LowMiss''' : Input (LowMiss) to [[flucut|FLUCUT]].
* '''TopZero''' : Input (TopZero) to [[flucut|FLUCUT]].
 
 
* '''TopMiss''' : Input (FopMiss) to [[flucut|FLUCUT]].
 
* '''TopMiss''' : Input (FopMiss) to [[flucut|FLUCUT]].
* '''xclreadr''' : XCLREADR options field for governing calls to [[xclreadr|XCLREADR]].
+
* '''textreadr''' : TEXTREADR options field for governing calls to [[textreadr|TEXTREADR]].
 +
* '''nonmatching''' : [{'error'}| 'cell' ] Governs handling non-matching data from multiple files.
  
 
===See Also===
 
===See Also===
  
[[Data Importing Formats]], [[hjyreadr]], [[jcampreadr]],
+
[[Data Importing Formats]], [[hjyreadr]], [[jascoeemreadr]], [[jcampreadr]],
 
[[spcreadr]], [[writespc]], [[xclreadr]]
 
[[spcreadr]], [[writespc]], [[xclreadr]]

Latest revision as of 11:38, 24 July 2017

Purpose

Reads Horiba JY Aqualog files with Raleigh removal.

Synopsis

out = aqualogreadr(file,options);

Inputs

  • file = One of the following identifications of files to read:
  • A single string identifying the file to read
('example')
  • A cell array of strings giving multiple files to read
({'example_a' 'example_b' 'example_c'})
  • An empty array indicating that the user should be prompted to locate the file(s) to read
([])

Outputs

  • out = A DataSet object with date, time, info (data from cell (1,1)), variable names (vars), sample names (samps), and data matrix (data).

Options

options = a structure array with the following fields:

  • waitbar : [ 'off' |{'on'}] Governs use of waitbars to show progress.
  • scattercorrection : [ {'off'} | 'on'] calls flucut for Rayleigh correction.
  • flucut : FLUCUT options field for governing calls to FLUCUT.
    • LowZero : Option (LowZero) for FLUCUT.
    • TopZero : Option (TopZero) for FLUCUT.
  • LowMiss : Input (LowMiss) to FLUCUT.
  • TopMiss : Input (FopMiss) to FLUCUT.
  • textreadr : TEXTREADR options field for governing calls to TEXTREADR.
  • nonmatching : [{'error'}| 'cell' ] Governs handling non-matching data from multiple files.

See Also

Data Importing Formats, hjyreadr, jascoeemreadr, jcampreadr, spcreadr, writespc, xclreadr