proj/mag/harp/libs/matlab/mfile-mex/standalone/Doc/cstat_docstring.h

/*
 * This file is generated by a script, do not edit.
 *
 * This documentation string was generated from
 * a C comment block within a mex program
 * by `doc2docstring.py' on Thu Jun 23 18:26:49 2011.
 */
 
static const char docstring[] =
    "cstat: compute class statistics\n"
    "\n"
    " [mu,sigma,ct] = cstat(image, label, K, mode)\n"
    " * For each `label' value from 1 to K, the mean, standard\n"
    " deviation, and count of the corresponding image pixels are found.\n"
    " NaNs in `image' are skipped.\n"
    " * Usable labels are integers from 1..K.  Labels <1, >= K+1, or NaN\n"
    " are skipped.  Fractional labels are rounded down.\n"
    " * K is the number of classes.  If omitted or given as empty,\n"
    " K is taken to be the maximum value of the labeling.\n"
    " * If mode contains 'no-sigma', sigma is not computed.  If mode\n"
    " contains 'no-mu', mu is not computed.  'no-mu' implies 'no-sigma'.\n"
    " * If image is given as empty, it is equivalent to 'no-mu', so only\n"
    " counts are computed.\n"
    " * If mode contains 'unscaled', mu is not normalized by ct, and sigma\n"
    " is not computed.\n"
    " * When un-computed output arguments must be returned, as in\n"
    "   [mu,sigma,ct] = cstat(image, label, [], 'no-mu')\n"
    " they are returned as empty.\n"
    "\n"
    " Inputs:\n"
    "  real image[m,n] or []\n"
    "  int  label[m,n]\n"
    "  opt  int K = max(label(:))\n"
    "  opt  string mode = ''\n"
    "\n"
    " Outputs:\n"
    "  real mu[1,K] or []\n"
    "  real sigma[1,K] or []\n"
    "  int  ct[1,K]\n"
    "\n"
    "\n"
    " turmon 7 Apr 2008 enhanced, cleaned up, better error detection\n"
    " turmon mar 2011 added modes\n"
    "\n"
    "";

/* End of generated file */

---