schiff

commit 97d635df25c51a9fc7a754bc3dcc5211d8f95d79
parent 2d88b9297ff2e0b60079e844c4f24306a7c50e14
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Mon,  9 Nov 2015 10:32:53 +0100

Document the output of the schiff command

Remove the comments from the command output.

Diffstat:
M
src/schiff.c
 | 
7
-------
M
src/schiff_args.c
 | 
9
++++++++-

2 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/src/schiff.c b/src/schiff.c
@@ -148,13 +148,6 @@ run_integration
   states = sa_add(states, nwlens);
   SSCHIFF(estimator_get_states(estimator, states));
 
-  fprintf(stream,
-"# Line format \"W E E' A A' S S' P P'\" with \"W\" the wavelength in meter,\n"
-"# \"E\", \"A\", and \"S\" the estimation of the extinction, absorption and\n"
-"# scattering cross section, respectively, and \"P\" the estimation of the\n"
-"# average projected area. The `prime' values, i.e. \"E'\", \"A'\", \"S'\" and \"P'\"\n"
-"# are the standard error of the aforementionned estimations.\n\n");
-
   /* Print the estimation results */
   FOR_EACH(iwlen, 0, nwlens) {
     const struct sschiff_estimator_value* val;
diff --git a/src/schiff_args.c b/src/schiff_args.c
@@ -58,7 +58,14 @@ print_help(const char* binary)
 "expressed  in  micron,   \"Nr\"  and  \"Kr\"  are  the  real  and  imaginary  parts,\n"
 "respectively,  of the relative refractive  index,  and \"Ne\" the refractive index\n"
 "of the medium.  With no FILE, read optical properties from standard input.\n\n");
-
+  printf(
+"The estimated  results are written to  OUTPUT or stdout whether  the \"-o\" option\n"
+"is defined or not,  respectively.  The line format of the outputed results is \"W\n"
+"E E' A  A' S S' P P'\"  with \"W\" the wavelength in  vacuum (expressed in micron),\n"
+"\"E\",  \"A\" and \"S\"  the estimation of the  extinction,  absorption and scattering\n"
+"cross section,  respectively, and \"P\" the estimated average projected area.  The\n"
+"\"E'\", \"A'\", \"S'\"  and \"P'\" values are  the standard error  of the aforementioned\n"
+"estimations.\n\n");
   printf(
 "  -c R:S:A[:N]  the micro  organisms  are  cylindrical  meshes  discretized in N\n"
 "                slices.  By default N is %u.  The  radius `r' and the height `h'\n"