Pcolormap: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Importing text file)
imported>Jeremy
No edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
===Purpose===
===Purpose===
Produces a pseudocolor map with labels.
 
Produces a pseudocolor map plot with labels and colorbar.
 
===Synopsis===
===Synopsis===
:pcolormap(data,''maxdat,mindat'')
 
:pcolormap(data,''xlbl,ylbl,maxdat,mindat'')
:pcolormap(data,''maxdat,mindat'')             %pcolor w/ labels for data of class "dataset"
:pcolormap(data,''xlbl,ylbl,maxdat,mindat'')   %pcolor w/ labels for data of class "double"
 
===Description===
===Description===
PCOLORMAP produces a pseudocolor map of the ''M'' by ''N'' input matrix data.
PCOLORMAP produces a pseudocolor map of the ''M'' by ''N'' input matrix data.
If data is class "double" the I/O format is:
If data is class "double" the I/O format is:
:pcolormap(data,xlbl,ylbl,maxdat,mindat)
 
pcolormap(data,xlbl,ylbl,maxdat,mindat)
 
If data is class "dataset" the I/O format is:
If data is class "dataset" the I/O format is:
:pcolormap(data,maxdat,mindat)
 
====OPTIONAL INPUTS====
pcolormap(data,maxdat,mindat)
(xlbl) a character array with m rows of sample labels if empty no labels are included, if == 1 then xlbl = int2str([1:m]'); [xlbl = int2str([1:m]') used when size(xlbl,1)\~=m],
 
(ylbl) a character array with n rows of variable labels if empty no labels are included, if ==1 then ylbl = int2str([1:n]'); [ylbl = int2str([1:n]') used when size(ylbl,1)\~=n],
====Inputs====
(maxdat) a user defined maximum for scaling the color scale {default = max(max(data))},
 
(mindat) a user defined minimum for scaling the color scale {default = min(min(data))}.
* '''data''' = input data, expressed in one of two forms:
** ''M'' by ''N'' matrix of class "double", OR
** dataset object
 
====Optional Inputs====
 
*'''xlbl''' = a character array with m rows of sample labels
** if empty, no labels are included
** if == 1 then xlbl = int2str([1:m]');  
** xlbl = int2str([1:m]') is used when size(xlbl,1)~= m  
*'''ylbl''' = a character array with n rows of variable labels
** if empty, no labels are included
** if == 1 then ylbl = int2str([1:n]')
** ylbl = int2str([1:n]') is used when size(ylbl,1)~=n
*'''maxdat''' = a user defined maximum for scaling the color scale {default = max(max(data))}
*'''mindat''' = a user defined minimum for scaling the color scale {default = min(min(data))}.
 
===See Also===
===See Also===
[[corrmap]], [[pcolor]], [[rwb]]
[[corrmap]], [[pcolor]], [[rwb]]

Latest revision as of 13:35, 10 October 2008

Purpose

Produces a pseudocolor map plot with labels and colorbar.

Synopsis

pcolormap(data,maxdat,mindat) %pcolor w/ labels for data of class "dataset"
pcolormap(data,xlbl,ylbl,maxdat,mindat) %pcolor w/ labels for data of class "double"

Description

PCOLORMAP produces a pseudocolor map of the M by N input matrix data.

If data is class "double" the I/O format is:

pcolormap(data,xlbl,ylbl,maxdat,mindat)

If data is class "dataset" the I/O format is:

pcolormap(data,maxdat,mindat)

Inputs

  • data = input data, expressed in one of two forms:
    • M by N matrix of class "double", OR
    • dataset object

Optional Inputs

  • xlbl = a character array with m rows of sample labels
    • if empty, no labels are included
    • if == 1 then xlbl = int2str([1:m]');
    • xlbl = int2str([1:m]') is used when size(xlbl,1)~= m
  • ylbl = a character array with n rows of variable labels
    • if empty, no labels are included
    • if == 1 then ylbl = int2str([1:n]')
    • ylbl = int2str([1:n]') is used when size(ylbl,1)~=n
  • maxdat = a user defined maximum for scaling the color scale {default = max(max(data))}
  • mindat = a user defined minimum for scaling the color scale {default = min(min(data))}.

See Also

corrmap, pcolor, rwb