proj/mag/ident/libs/mexfunctions/Doc/hmi_segment_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 Fri Jul  8 15:24:12 2011.
 */
 
static const char docstring[] =
    "hmi_segment    driver for HMI segmentation\n"
    "\n"
    " [y,s,post,nclean]=hmi_segment(xm,xp,edge,iter,T,beta,alpha,geom,rho,m1,...)\n"
    " * Integrated routine for deriving HMI segmentations.  Uses\n"
    " models (m1,m2,...), plus a magnetogram-photogram pair (xm,xp),\n"
    " to deduce an integer labeling.  Besides images and models,\n"
    " it also requires some disk parameters and labeling smoothness\n"
    " parameters.\n"
    " * The defaults for iter and T are inherited from mrf_segment_wts,\n"
    " and should be looked up there.\n"
    " * The posterior probability `post' of the mrf fit can be returned;\n"
    " this can quickly verify repeatability.\n"
    " * The extreme limb can be a problem for labeling; `edge' helps with\n"
    " this.  We set the last edge(1) pixels to the value edge(2), and\n"
    " return the number of such pixels modified, optionally, in nclean.\n"
    " Typically edge=[3 1]; both can be real-valued.\n"
    "\n"
    " Inputs:\n"
    "   real xm(m,n)\n"
    "   real xp(m,n)\n"
    "   real edge(2)\n"
    "   int iter(1) or (2)\n"
    "   real T[0] or [1] or [2] or [3] or [4]\n"
    "   real beta[1] or [K,K]\n"
    "   real alpha[K] or [0] = []\n"
    "   real geom(5)\n"
    "   real rho\n"
    "   real m1(l,k1)\n"
    "   ...\n"
    "   real mR(l,kR)\n"
    "\n"
    " Outputs:\n"
    "   int y(m,n)\n"
    "   opt real s(R,nS)\n"
    "   opt real post\n"
    "   opt int nclean\n"
    "\n"
    " See Also:  makemrfdiscwts, mrf_segment_wts, mixNprobNd,\n"
    "            clean_edge_label, roi_stats_mag\n"
    "\n"
    " turmon oct 2009, june 2010, june 2011\n"
    "\n"
    "";

/* End of generated file */

---