mat2dcorr - Matlab toolbox for 2D correlation analysis
version 1.05 Dec 22, 2024
Copyright Peter Lasch 2010-2025. CC-BY-NC license
email: laschp@rki.de

A.) REQUIRED FILES

 1.) mat2dcorr.m (Matlab source code file)
 2.) updcorrplt.m (Matlab source code file)
 3.) resiz2dfig.m (Matlab source code file)
 4.) readme.txt (this file)

B:) EXAMPLE & TEST DATA FILES

 5.) linescandata.xlsx (spectral data file, Excel trace data format)
    (contains the same data as linescandata.mat)
 6.) linescandata.mat (spectral data file, Matlab trace data format)    
 7.) IR-cerebellum-50x50.mat      - IR hyperspectral image data (50 x 50 spectra) 
 8.) MALDI-cerebellum-50x50.mat   - MALDI hyperspectral image data (50 x 50 spectra)
 9.) Raman-cerebellum-50x50.mat   - Raman hyperspectral image data (50 x 50 spectra)
10.) IR-cerebellum-100x100.mat    - IR hyperspectral image data (100 x 100 spectra) 
11.) MALDI-cerebellum-100x100.mat - MALDI hyperspectral image data (100 x 100 spectra) 
12.) Raman-cerebellum-100x100.mat - Raman hyperspectral image data (100 x 100 spectra) 
13.) fftsyncro.mat                - result file of 2D correlation analysis by the 
                                    mat2dcorr toolbox using the FFT 2D-COS option
14.) statssyncro.mat              - result file of 2D correlation analysis by the 
                                    mat2dcorr toolbox using the statistical 2D-COS option

C.) INSTALLATION

1.) Requires Matlab R2014a or newer
2.) Download and copy files 1.)-4.) into a separate directory
3.) Add this directory to Matlab's search path
    For this start Matlab and type

        >> addpath('Mat2DcorrPath')

    at the Matlab command prompt
    'Mat2DcorrPath' denotes the full path to the *.m files,
    example: 'C:\Users\Tim\Documents\Matlab\mat2dcorr'
4.) Type then

        >> mat2dcorr;

    at the Matlab prompt to start
	
D.) FORMAT OF EXAMPLE FILE 
    e.g. 'linescandata.mat' [see section B, file No. 5.), Matlab trace format]

    Matlab trace format files are Matlab files in which the following variables are stored:
    spc - The spectral data, a 2D array of double precision floating point values (float32). 
        Columns indicate individual spectra of absorbance, intensity, transmittance or other 
        values; the column length equals the number of spectral data points, the number of 
        columns indicates the number of spectra (i.e. of observations)
    wav - A vector of float32 values, the 'wavenumber' vector, or more general the vector of 
        y-values (frequencies, wavenumbers, Raman shift, or other y-values), 'wav' must equal 
        size(spc,1) and be should be increasing while equal point spacing is not a requirement
    tos - A character vector of variable length to indicate the spectra type. Examples: 'IR 
        Transmission', 'Fluoresence', 'Raman', etc
    vst - A character vector of variable length indicating the type of the perturbing variable. 
        Examples 'Temperature', 'Time', 'Voltage', or 'Spatial variable'.
    war - A vector of float32 values, the perturbing variable of the experiment. Examples: 
        [10 11 12 ... 45] in case of vst = 'Temperature'. The length of 'war' must be equal to 
        size(spc,2).

For more details see the mat2dcorr Wiki at https://wiki2dcos.microbe-ms.com