[Teem-commit] SF.net SVN: teem:[4814] teem/trunk/src/unrrdu

[<kin...@us...>]

Revision: 4814
          http://teem.svn.sourceforge.net/teem/?rev=4814&view=rev
Author:   kindlmann
Date:     2011-05-28 00:11:21 +0000 (Sat, 28 May 2011)

Log Message:
-----------
starting to add info about underlying nrrd library calls

Modified Paths:
--------------
    teem/trunk/src/unrrdu/cmedian.c
    teem/trunk/src/unrrdu/convert.c
    teem/trunk/src/unrrdu/dist.c
    teem/trunk/src/unrrdu/minmax.c
    teem/trunk/src/unrrdu/resample.c

Modified: teem/trunk/src/unrrdu/cmedian.c
===================================================================
--- teem/trunk/src/unrrdu/cmedian.c	2011-05-28 00:10:34 UTC (rev 4813)
+++ teem/trunk/src/unrrdu/cmedian.c	2011-05-28 00:11:21 UTC (rev 4814)
@@ -34,7 +34,9 @@
  "of bins in the histogram, which probably means a loss of precision for "
  "anything except 8-bit data.  Also, integral values can be recovered "
  "exactly only when the number of bins is exactly min-max+1 (as reported "
- "by \"unu minmax\"). ");
+ "by \"unu minmax\").\n "
+ "(Based on nrrdCheapMedian, plus nrrdSlice and nrrdJoin in "
+ "case of \"-c\")");
 
 int
 unrrdu_cmedianMain(int argc, const char **argv, char *me, hestParm *hparm) {

Modified: teem/trunk/src/unrrdu/convert.c
===================================================================
--- teem/trunk/src/unrrdu/convert.c	2011-05-28 00:10:34 UTC (rev 4813)
+++ teem/trunk/src/unrrdu/convert.c	2011-05-28 00:11:21 UTC (rev 4814)
@@ -32,7 +32,8 @@
  "clamping values to the representable range of the output type is possible. "
  "with \"-clamp\". "
  "See also \"unu quantize\","
- "\"unu 2op x\", and \"unu 3op clamp\".");
+ "\"unu 2op x\", and \"unu 3op clamp\".\n "
+ "(Based on: nrrdConvert, nrrdClampConvert)");
 
 int
 unrrdu_convertMain(int argc, const char **argv, char *me, hestParm *hparm) {

Modified: teem/trunk/src/unrrdu/dist.c
===================================================================
--- teem/trunk/src/unrrdu/dist.c	2011-05-28 00:10:34 UTC (rev 4813)
+++ teem/trunk/src/unrrdu/dist.c	2011-05-28 00:11:21 UTC (rev 4814)
@@ -32,7 +32,8 @@
  "This function first thresholds at the specified value and then "
  "does the distance transform of the resulting binary image. "
  "The signed distance (negative values inside object) is also available. "
- "Distances between non-isotropic samples are handled correctly.");
+ "Distances between non-isotropic samples are handled correctly.\n "
+ "(Based on nrrdDistanceL2 and nrrdDistanceL2Signed)");
 
 int
 unrrdu_distMain(int argc, const char **argv, char *me, hestParm *hparm) {

Modified: teem/trunk/src/unrrdu/minmax.c
===================================================================
--- teem/trunk/src/unrrdu/minmax.c	2011-05-28 00:10:34 UTC (rev 4813)
+++ teem/trunk/src/unrrdu/minmax.c	2011-05-28 00:11:21 UTC (rev 4814)
@@ -27,7 +27,8 @@
 char *_unrrdu_minmaxInfoL =
 (INFO ". Unlike other commands, this doesn't produce a nrrd.  It only "
  "prints to standard out the min and max values found in the input nrrd(s), "
- "and it also indicates if there are non-existant values.");
+ "and it also indicates if there are non-existant values.\n "
+ "(Based on nrrdRangeNewSet)");
 
 int
 unrrdu_minmaxDoit(char *me, char *inS, int blind8BitRange, FILE *fout) {
@@ -69,8 +70,9 @@
   hestOptAdd(&opt, "blind8", "bool", airTypeBool, 1, 1, &blind8BitRange,
              "false", /* NOTE: not using nrrdStateBlind8BitRange here 
                          for consistency with previous behavior */
-             "whether to know the range of 8-bit data blindly "
-             "(uchar is always [0,255], signed char is [-128,127])");
+             "whether to blindly assert the range of 8-bit data, "
+             "without actually going through the data values, i.e. "
+             "uchar is always [0,255], signed char is [-128,127]");
   hestOptAdd(&opt, NULL, "nin1", airTypeString, 1, -1, &inS, NULL,
              "input nrrd(s)", &ninLen);
   airMopAdd(mop, opt, (airMopper)hestOptFree, airMopAlways);

Modified: teem/trunk/src/unrrdu/resample.c
===================================================================
--- teem/trunk/src/unrrdu/resample.c	2011-05-28 00:10:34 UTC (rev 4813)
+++ teem/trunk/src/unrrdu/resample.c	2011-05-28 00:11:21 UTC (rev 4814)
@@ -38,7 +38,8 @@
  "or to crop and/or pad via \"-min\" and \"-max\". "
  "The resampling respects the difference between cell- and "
  "node-centered data, but you can over-ride known centering "
- "with \"-co\".");
+ "with \"-co\".\n "
+ "(Based on nrrdResample* functions around nrrdResampleContext)");
 
 int
 unrrdu_resampleMain(int argc, const char **argv, char *me, hestParm *hparm) {


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.