Spcreadr and Nvalidate: Difference between pages

From Eigenvector Research Documentation Wiki
(Difference between pages)
Jump to navigation Jump to search
imported>Donal
 
imported>Mathias
 
Line 1: Line 1:
===Purpose===
===Purpose===


Reads a Galactic SPC file.
Validate the number PARAFAC or Tucker components.


===Synopsis===


:x = spcreadr(filename,''subs,wlrange,options'')
:[data,xaxis,auditlog,description] = spcreadr(filename,''subs,wlrange,options'')


===Description===
===Synopsis===
 
SPCREADR reads a Galactic SPC file.
 
====Inputs====
 
* '''filename''' = a text string with the name of a SPC file or a cell of strings of SPC filenames.
::If (filename) is omitted or an empty cell {}, the user will be prompted to select a folder and then one or more SPC files in the identified folder.
 
::If filename is a blank string, the user will be prompted to select a file. Importer will also load DHB files.
 
====Optional Inputs====
 
* '''''subs''''' = [], scalar or vector indicating the sub-files to read, e.g. [3] reads sub-file 3, [3:9] reads sub-files 3 to 9, {default reads all sub-files} and
 
* '''''wlrange''''' = [], two element vector (inclusive endpoints) of the wavelength range to return {default returns the entire wavelength range}.
 
====Outputs====
 
* '''x''' = a dataset object containing the spectrum, or
 
* '''data''' = a data array with measured intensities,
 
* '''xaxis''' = vector containing the wavelength axis, and
 
* '''auditlog''' = char array with the log from the file.
 
===Options===
 
''options'' =  a structure array with the following fields:
 
* '''axismatching''': [ 'none' | 'intersect' |{'interpolate'} ], defines action taken when the x-axes of two spectra being read do not match. The options are:
**  ''''intersect'''' returns only the points where the spectral x-axis values overlap excatly.
**  ''''interpolate'''' returns the overlapping portions with linear interpolation to match spectral points exactly. As no extrapolation will be done, the returned spectra will cover the smallest common spectral range.
**  ''''none'''' ignores x-axis differences as long as the number of data points is the same in all spectra.


* '''textauditlog''': [ {'no'} | 'yes' ], governs output of audit log contents. When 'yes', the auditlog is returned as a raw text array. Otherwise, the auditlog is returned as a structure with field names taken from  auditlog keys.
:result = nvalidate(x,ncomp,method,options);
:nvalidate(result,x)  %Plot earlier results
:nvalidate(x,1:3,'parafac')  % Validate 1-3 component PARAFAC models
:nvalidate(x,[1 1 1;3 3 3],'tucker') % validate [1 1 1] to [3 3 3] comp Tucker3 models


===See Also===


[[autoimport]], [[xclreadr]], [[writespc]]
===Inputs ===

Revision as of 11:03, 2 August 2016

Purpose

Validate the number PARAFAC or Tucker components.


Synopsis

result = nvalidate(x,ncomp,method,options);
nvalidate(result,x) %Plot earlier results
nvalidate(x,1:3,'parafac')  % Validate 1-3 component PARAFAC models
nvalidate(x,[1 1 1;3 3 3],'tucker') % validate [1 1 1] to [3 3 3] comp Tucker3 models


Inputs