Changeset 1879 for trunk/psLib/src/math/psStats.h

Timestamp:

Sep 24, 2004, 10:08:22 AM (22 years ago)

Author:

gusciora

Message:

psCOmments.h

File:

• trunk/psLib/src/math/psStats.h (modified) (6 diffs)

trunk/psLib/src/math/psStats.h

@@ -10 +10 @@
  *  @author George Gusciora, MHPCC
  *
- *  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-11 19:16:04 $
+ *  @version $Revision: 1.26 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-09-24 20:08:22 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -31 +31 @@
  *  @see psStats, psVectorStats, psImageStats
  */
+// XXX: Is PS_STAT_ROBUST_FOR_SAMPLE obsolete?
 typedef enum {
     PS_STAT_SAMPLE_MEAN = 0x000001,
@@ -43 +44 @@
     PS_STAT_CLIPPED_MEAN = 0x000200,
     PS_STAT_CLIPPED_STDEV = 0x000400,
-    PS_STAT_MAX = 0x000800,
-    PS_STAT_MIN = 0x001000,
-    PS_STAT_USE_RANGE = 0x002000,
+    PS_STAT_MAX =  0x000800,
+    PS_STAT_MIN =  0x001000,
+    PS_STAT_USE_RANGE =  0x002000,
     PS_STAT_USE_BINSIZE = 0x004000,
     PS_STAT_ROBUST_FOR_SAMPLE = 0x008000
@@ -60 +61 @@
     double sampleUQ;            ///< upper quartile of sample
     double sampleLQ;            ///< lower quartile of sample
-    double sampleLimit;         ///<
     double robustMean;          ///< robust mean of array
     double robustMedian;        ///< robust median of array
@@ -67 +67 @@
     double robustUQ;            ///< robust upper quartile
     double robustLQ;            ///< robust lower quartile
-    double XXX;
     double robustN50;           ///<
     double robustNfit;          ///<
     double clippedMean;         ///< Nsigma clipped mean
     double clippedStdev;        ///< standard deviation after clipping
+    int clippedNvalues          ///< ???
     double clipSigma;           ///< Nsigma used for clipping; user input
     int clipIter;               ///< Number of clipping iterations; user input
@@ -86 +86 @@
  */
 psStats* psVectorStats(
-    psStats* stats,
-    ///< stats structure defines stats to be calculated and how
-
-    psVector* in,
-    ///< Vector to be analysed: must be F32
-
-    psVector* mask,
-    ///< Ignore elements where (maskVector & maskVal) != 0: must be INT or NULL
-
-    unsigned int maskVal
-    ///< Only mask elements with one of these bits set in maskVector
+    psStats* stats,    ///< stats structure defines stats to be calculated and how
+    psVector* in,    ///< Vector to be analysed: must be F32
+    psVector* mask,    ///< Ignore elements where (maskVector & maskVal) != 0: must be INT or NULL
+    unsigned int maskVal    ///< Only mask elements with one of these bits set in maskVector
 );