.ig >>
<STYLE TYPE="text/css">
<!--
        A:link{text-decoration:none}
        A:visited{text-decoration:none}
        A:active{text-decoration:none}
        OL,UL,P,BODY,TD,TR,TH,FORM { font-family: arial,helvetica,sans-serif;; font-size:small; color: #333333; }

        H1 { font-size: x-large; font-family: arial,helvetica,sans-serif; }
        H2 { font-size: large; font-family: arial,helvetica,sans-serif; }
        H3 { font-size: medium; font-family: arial,helvetica,sans-serif; }
        H4 { font-size: small; font-family: arial,helvetica,sans-serif; }
-->
</STYLE>
<title>ploticus: heatmap prefab</title>
<body bgcolor=D0D0EE vlink=0000FF>
<br>
<br>
<center>
<table cellpadding=2 bgcolor=FFFFFF width=550><tr>
<td>
  <table cellpadding=2 width=550><tr>
  <td><br><h2>heatmap prefab</h2></td>
  <td align=right>
  <small>
  <a href="../doc/welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
  Version 2.30
     </small><br><a href="../doc/prefabs.html">Prefabs</a>
  <td></tr></table>
</td></tr>
<td>
<br>
<br>
.>>

.TH heatmap_prefab PL "25-AUG-2004   PL ploticus.sourceforge.net"

.ig >>
<center><a href="prefab_heatmap_ex.html"><img src="../gallery/prefab_img/heatmap2thm.gif" border=0>
 <br><b>View the heatmap prefab examples</a></b><br><br></center>
.>>


.LP
\fBheatmap\fR is a 
.ig >>
<a href="prefabs.html">
.>>
\0prefab
.ig >>
</a>
.>>
for producing heatmaps, density grids and similar displays.
Data can be continuous numeric or categorical.  Numeric data will be fitted into bins.
Instance counts are displayed unless \fCcontentfield\fR is specified.
The binsizes and color breakdown can be automatically determined or 
specified explicitly for faster performance.

.ig >>
<br><br><br>
.>>


.SH Parameters

.ig >>

<table cellpadding=2 bgcolor=A0A0A0 width=600>

<tr bgcolor=FFFFEC align=center><td><b>Prefab<br>parameter<br>name</td><td>Data type</td>
<td>Default</td><td>Description</td>
<td>Examples<br><small>(ignore line wrapping)</td></tr>


<tr bgcolor=FFFFFF>
<td><b><a href="prefab_stdparms.html">Standard parameters</a></td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td colspan=2>Most of the <a href="prefab_stdparms.html">standard prefab parameters</a> may be used.
You <font color=D00000>must specify</font> <b>data</b> (the name of the input data file).
The clickmap parameters and <b>ptselect</b> aren't available with this prefab.
</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>x</td>
<td><a href="atypes.html#dfield">data field</a></td>
<td><font color=D00000>must be specified</font></td>
<td><nobr>Identifies the data field that will hold</nobr> X component.</td>
<td><tt>x=2<br>x=pmb</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>y</td>
<td><a href="atypes.html#dfield">data field</a></td>
<td><font color=D00000>must be specified</font></td>
<td>Identifies the data field that will hold Y component.</td>
<td><tt>y=3<br>y=pmr</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>xcats</td>
<td><tt>yes</tt> or <tt>no</td>
<td><tt>no</td>
<td>If <tt>yes</tt>, indicates that X component is categorical, not continuous numeric.</td>
<td><tt>xcats=yes</td>
</tr>


<tr bgcolor=FFFFFF>
<td><b>xbinsize<br><br>ybinsize</td>
<td>numeric</td>
<td>based on data</td>
<td>Explicitly specify bin size for continuous numeric data.
If not specified these will be determined automatically, at some cost in performance.</td>
<td><tt>ybinsize=2.5</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>cutofflist</td>
<td><i>commalist of numerics</td></td>
<td>based on data</td>
<td>Explicitly specify the cutoffs for color breakdown.
<i>commalist</i> is a comma-delimited list of numeric values, from large
magnitude to small.  If not specified a reasonable (but probably not ideal) breakdown 
of 6 color categories will be provided automatically, at some cost in performance.
<i>commalist</i> cannot contain embedded spaces.</td>
<td><tt>cutofflist=50,40,30,15,1</tt> 
(would produce color categories of 50+, 40-49, 30-39, 15-29, and 1-14).
</td>
</tr>


<tr bgcolor=FFFFFF>
<td><b>colorlist</td>
<td><i>commalist of <a href="color.html">colors</a></td>
<td><tt>yellow,dullyellow,<br>orange,red,lightpurple,<br>purple</td>
<td>Specify the colors to be used for cells.
The first color in <i>commalist</i> will go to the highest magnitude category.
There should be enough colors to cover all categories.
<i>commalist</i> may not contain embedded spaces.</td>
<td><tt>colorlist=white,limegreen,<br>green,teal,blue,<br>purple,black</tt></td>
</tr>


<tr bgcolor=FFFFFF>
<td><b>zerocolor</td>
<td><a href="color.html">color</a></td>
<td><tt>black</td>
<td>The plotting area will be initialized to this color.</td>
<td><tt>zerocolor=gray(0.8)</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>contentfield</td>
<td><a href="atypes.html#dfield">datafield</td>
<td>&nbsp;</td>
<td>If specified, indicates that instances are not to be counted, but instead, the
value in this field will determine the color for a given cell.  Thus with
<b>contentfield</b> there can be no more than one data row for any cell position.</td>
<td><tt>contentfield=5<br><br>contentfield=fcount</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>symbol</b></td>
<td><a href="symboldetails.html">symboldetails</a></td>
<td>&nbsp;</td>
<td>Specifies a data point symbol to be used instead of the usual rectangle.
<tt>style=filled</tt> is assumed, and there's no need to specify color.</td>
<td><tt>"symbol= shape=diamond radius=0.1"</td>
</tr>


<tr bgcolor=FFFFFF>
<td><b>outline</b></td>
<td><tt>yes</tt><br>or<br><tt><a href="linedetails.html">linedetails</a></td>
<td>&nbsp;</td>
<td>If specified, cells will be outlined.  <tt>yes</tt> gives a standard black line.</td>
<td><tt>"outline= color=gray(0.7) width=3"</td>
</tr>

</table>
.>>

.ig >>
<br>
<br>
</td></tr>
<td align=right>
<a href="../doc/welcome.html">
<img src="../doc/ploticus.gif" border=0></a><br><small>data display engine &nbsp; <br>
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
<br>
<br>
<center>
<img src="../gallery/all.gif"> 
</center>
</td></tr>
</table>
.>>
