Texture and Cytospecreadr: Difference between pages

From Eigenvector Research Documentation Wiki
(Difference between pages)
Jump to navigation Jump to search
imported>Scott
 
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===
Run texture analysis on an image or group of images.
 
Reads CytoSpec .cyt files.
:Note: This importer is available in PLS_Toolbox/Solo Versions 8.6 and newer.


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


:[y,varargout]= texture(img, method, options, varargin)
:out = cytospecreadr(file);
 
===Description===
TEXTURE will perform an analysis on any 2 dimensional (m x n pixels) layer of an image or group of images. It loops through input 'img' where mode 3 is considered the variables (slabs of an image) mode and mode 4 is considered the images mode. Any additional inputs to the chosen 'method' must be added after the options input.
 
Outputs are 'y' a dataset with each row corresponding to an image and varargout containing any secondary output from the selected method. Outputs for a 'method' must be designated by the user with options.numout. Outputs will be appended together forming one row vector per image. E.G. for 'anglemt' if options.numout = [2 1] then the y{2} and y{1} outputs of 'anglemt' will be concatenated to form the row. Only the first output of a function is used. If there is a second output of a function it is assigned to varargout.
 
Aggregation can be performed across variables (slabs/layers) and or across images. For example, setting options.varmode = 'sum' will sum the layer of an image into one layer.


====Inputs====
====Inputs====
* '''img''' = image data (matrix or DataSet). The first two modes must be pixels, the third mode must be variables, and the fourth mode must be images.
* '''file''' = One of the following identifications of files to read:
* '''method''' = texture method ('anglemt' 'autocor_img' 'svd_texture' 'fft_texture' 'semivar').
:* A single string identifying the file to read
 
:: ('example')
====Optional Inputs====
:* A single element cell array containing a strings name of a file to read
* '''varargin''' = additional input needed for selected 'method'.
:: ({‘example’})
:* An empty array indicating that the user should be prompted to locate the file(s) to read
:: ([])


====Outputs====
====Outputs====
* '''firstout''' = first output is this.
* '''out''' = A DataSet object containing the imported data.  
* '''y''' = dataset where each row (spectra) corresponds to an image.
* '''varargout''' = second ouput of a function (e.g. for anglemt this would be 's', the distance scales). Will transform into row vector of cells.
 
===Options===
 
options =  a structure array with the following fields:
 
* '''numout''': [{1}] 1xK vector. Number and order of outputs from selected 'method' to use.
* '''imgmode''': [ {'none'} | 'sum' | 'mean' ] aggregation across images.
* '''varmode''': [ {'none'} | 'sum' | 'mean' ] aggregation across variables.
 
TEXTURE FUNCTION SUB-STRUCTURES
These options can be assigned in their nested form. See the particular function for a full description of available options. For example:
: <tt>options.anglemt.xscale = [1:100];</tt>


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


[[anglemt]], [[autocor_img]], [[detrend_img]], [[fft_texture]], [[semivar]], [[svd_texture]]
[[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