<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='stackms1'>
<!--  @(#)stackms.1 2001/04/02 NIST -->
<!--  I Image Group -->
<!--  G. T. Candela &amp; Craig I. Watson -->

<refmeta>
<refentrytitle>STACKMS</refentrytitle>
<manvolnum>1A</manvolnum>
<refmiscinfo class='date'>02 April 2001</refmiscinfo>
<refmiscinfo class='source'>NIST</refmiscinfo>
<refmiscinfo class='manual'>NFIS Reference Manual</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>stackms</refname>
<refpurpose>stacks PCASYS formatted matrix files together.</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
  <command>stackms</command>    
    <arg choice='plain'><replaceable>&lt;matrixfile_in</replaceable></arg>
    <arg choice='opt' rep='repeat'><replaceable>matrixfile_in</replaceable></arg>
    <arg>&gt;</arg>
    <arg choice='plain'><replaceable>&lt;matrixfile_out&gt;&lt;matrixfile_out_desc&gt;&lt;ascii_outfilemessages&gt;</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>


<refsect1 id='description'><title>DESCRIPTION</title>
<para><emphasis remap='B'>Stackms</emphasis>
stacks together several PCASYS "matrix" files: produces a file whose
matrix has, as its rows, the rows of all the input matrices. All input
matrices must have the same second dimension.  (The standard "cat"
(catenate files) command is insufficient for proper stacking of matrix
files, since the files contain header information and not just the
rows of entries.)</para>
</refsect1>

<refsect1 id='options'><title>OPTIONS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><emphasis remap='I'>&lt;matrixfile_in[matrixfile_in...]&gt;</emphasis></term>
  <listitem>
<para>The matrix files to be read.  (Can be ascii or binary, and they don't
all have to have the same ascii/binary setting.)  All must have the
same second dimension.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&lt;matrixfile_out&gt;</emphasis></term>
  <listitem>
<para>The matrix file to be written.  Its rows will be the rows of all the
input matrices.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&lt;matrixfile_out_desc&gt;</emphasis></term>
  <listitem>
<para>A string to be written into the output matrix file as its description
string; must contain no embedded newline characters.  If it contains
spaces, tabs, or shell metacharacters that are not to be expanded,
then it should be quoted.  To leave the description empty, use '' (two
single quote marks, i.e. a single-quoted empty string).  To let
stackms make the description (stating that the file was made by
stackms, and listing the names of the input files), use - (hyphen).</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&lt;ascii_outfile&gt;</emphasis></term>
  <listitem>
<para>If y, stackms makes an ascii output file; if n, it makes a binary
output file.  Binary is recommended, unless the output file must be
portable across different byte orders or floating-point formats.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&lt;messages&gt;</emphasis></term>
  <listitem>
<para>If y, stackms writes a progress message to the standard output each
time it is about to start reading a new input file; if n, no messages.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='examples'><title>EXAMPLE(S)</title>
<para>From <emphasis remap='I'>test/pcasys/execs/stackms/stackms.src</emphasis>:</para>

<!-- .RS -->
<para><emphasis remap='B'>% stackms ../meancov/fv1.men ../meancov/fv2.men tst.men - n y</emphasis>
<!-- .br -->
Combines the mean files <emphasis remap='I'>fv1.men</emphasis> and <emphasis remap='I'>fv2.men</emphasis> into
a single file.  This is only and example, the <emphasis remap='B'>cmbmcs</emphasis> should
be used to combine mean files.  The mean files were used to preserve
disk space.  The <command>stackms</command> in practice is used to combine feature
vector files (ie. where one wants to stack the data in the files).</para>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>asc2bin (1A), bin2asc (1A)</para>


</refsect1>

<refsect1 id='author'><title>AUTHOR</title>
<para>NIST/ITL/DIV894/Image Group</para>
</refsect1>
</refentry>

