Aqualogreadr: Difference between revisions
Jump to navigation
Jump to search
imported>Scott (Created page with " ===Purpose=== Reads JYHoriba Floromax ASCII files in as a DataSet Object. ===Synopsis=== :code here ===Description=== Description of the function and optionally include ot...") |
imported>Scott No edit summary |
||
Line 1: | Line 1: | ||
===Purpose=== | ===Purpose=== | ||
Line 7: | Line 5: | ||
===Synopsis=== | ===Synopsis=== | ||
: | :out = fluoromaxreadr(file,options); | ||
= | |||
====Inputs==== | ====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==== | ====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=== | ||
Line 26: | Line 23: | ||
options = a structure array with the following fields: | options = a structure array with the following fields: | ||
* ''' | * '''waitbar''' : [ 'off' |{'on'}] Governs use of waitbars to show progress. | ||
* ''' | * '''scattercorrection''' : [ 'off' | {'on'}] calls FLUCUT.M for Rayleigh correction. | ||
* '''flucut''' : FLUCUT options field for governing calls to [[flucut|FLUCUT]]. | |||
* '''LowZero''' : Input (LowZero) to [[flucut|FLUCUT]]. | |||
* '''LowMiss''' : Input (LowMiss) to [[flucut|FLUCUT]]. | |||
* '''TopZero''' : Input (TopZero) to [[flucut|FLUCUT]]. | |||
* '''TopMiss''' : Input (FopMiss) to [[flucut|FLUCUT]]. | |||
* '''xclreadr''' : XCLREADR options field for governing calls to [[xclreadr|XCLREADR]]. | |||
===See Also=== | ===See Also=== | ||
[[ | [[areadr]], [[dataset]], [[flucut]], [[spcreadr]], [[xclreadr]], [[xlsreadr]] |
Revision as of 12:30, 9 November 2011
Purpose
Reads JYHoriba Floromax ASCII files in as a DataSet Object.
Synopsis
- out = fluoromaxreadr(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.M for Rayleigh correction.
- flucut : FLUCUT options field for governing calls to FLUCUT.
- LowZero : Input (LowZero) to FLUCUT.
- LowMiss : Input (LowMiss) to FLUCUT.
- TopZero : Input (TopZero) to FLUCUT.
- TopMiss : Input (FopMiss) to FLUCUT.
- xclreadr : XCLREADR options field for governing calls to XCLREADR.