Preprocessiterator and Cytospecreadr: Difference between pages

From Eigenvector Research Documentation Wiki
(Difference between pages)
Jump to navigation Jump to search
imported>Scott
No edit summary
 
imported>Benjamin
(Created page with "===Purpose=== Reads CytoSpec .cyt files. :Note: This importer is available in PLS_Toolbox/Solo Versions 8.6 and newer. ===Synopsis=== :out = cytospecreadr(file); ====Input...")
 
Line 1: Line 1:
===Purpose===
===Purpose===


Create array of preprocessing combinations for use with [[modeloptimizer]].
Reads CytoSpec .cyt files.
:Note: This importer is available in PLS_Toolbox/Solo Versions 8.6 and newer.


===Synopsis===
===Synopsis===


: pplist = preprocessiterator(inpp);%Shows gui for iterator settings.
:out = cytospecreadr(file);
: pplist = preprocessiterator(inpp,imatrix);%Command line call.


===Description===
====Inputs====
* '''file''' = One of the following identifications of files to read:
:* A single string identifying the file to read
:: ('example')
:* A single element cell array containing a strings name of a file to read
:: ({‘example’})
:* An empty array indicating that the user should be prompted to locate the file(s) to read
:: ([])


For given input preprocessing structure (inpp), create combinations of preprocessing based on PP methods that can be iterated over using simple min/steps/max values. If iteration matrix (imatrix) is not provided a window will appear allowing user to specify iterations. Some of the methods are discussed in [[Advanced_Preprocessing | Advanced Preprocessing]].
====Outputs====
 
* '''out''' = A DataSet object containing the imported data.  
Supported Preprocessing Methods:
# Derivative ([[Savgol]])
# [[Normaliz | Normalize]]
# [[glsw | GLS Weighting]]
# [[glsw | EPO Filter]]
# [[wlsbaseline | Baseline (Automatic Whittaker Filter)]]
# [[baseline | Detrend]]
# [[Gapsegment | Gap Segment Derivative]]
# [[Auto | Autoscale]]
# [[poissonscale | Poisson (Sqrt Mean) Scaling]]
 
 
Iterator Matrix (imatrix) example. Cell array n x 9 with following columns:
 
# Relative Index - Relative index of given method.
# Preprocess Name - Name of preprocess method.
# Parameter Name - Name of .userdata parameter.
# Parameter Variable - Name of .userdata field.
# Data Type - Allowed values for Min and Max.
# Min - First value.
# Step - Size of interval of each step.
# Max - Last value.
# Use Log - Use a log scale to create values.
 
 
<pre>
inpp = preprocess('default','mean center','derivative','normalize', 'mean center','sqmnsc','normalize','log10','whittaker');
 
imatrix = { 1 'derivative' 'Width' 'width' 'int(1:inf)' 1 1 1 0;
1 'derivative' 'Derivative' 'deriv' 'int(1:inf)' 1 1 1 0;...
1 'derivative' 'Order' 'order' 'int(1:inf)' 1 1 1 0;
2 'Normalize' 'Norm Type' 'normtype' 'int(1:inf)' 1 2 2 0;...
1 'GLS Weighting' 'Alpha' 'a' 'float(0:inf)' 1 1 1 1};
 
pplist = preprocessiterator(inpp,imatrix)</pre>
 
NOTE:  If the original preprocess structure contains 2 Normalize steps, the second Normalize will be iterated over.


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


[[preprocess]], [[preprouser]]
[[Data Importing Formats]], [[hjyreadr]], [[aqualogreadr]], [[jascoeemreadr]], [[jcampreadr]],
[[spcreadr]], [[writespc]], [[xclreadr]]

Latest revision as of 11:12, 7 November 2017

Purpose

Reads CytoSpec .cyt files.

Note: This importer is available in PLS_Toolbox/Solo Versions 8.6 and newer.

Synopsis

out = cytospecreadr(file);

Inputs

  • file = One of the following identifications of files to read:
  • A single string identifying the file to read
('example')
  • A single element cell array containing a strings name of a file to read
({‘example’})
  • An empty array indicating that the user should be prompted to locate the file(s) to read
([])

Outputs

  • out = A DataSet object containing the imported data.

See Also

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