Changeset 4138 for trunk/psLib/src/dataManip/psStats.h

Timestamp:

Jun 7, 2005, 1:11:54 PM (21 years ago)

Author:

gusciora

Message:

I added comments to not the following dtats members are never being used, or
set:

stats->robustN50
stats->clippedNvalues
stats->binsize

File:

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

trunk/psLib/src/dataManip/psStats.h

@@ -1 @@
-
 /** @file  psStats.h
  *  \brief basic statistical operations
  *  @ingroup Stats
  *
-xd *  This file will hold the definition of the histogram and stats data
+ *  This file will hold the definition of the histogram and stats data
  *  structures.  It also contains prototypes for procedures which operate
  *  on those data structures.
  *
- *  @author George Gusciora, MHPCC
+ *  XXX: The following stats members are never used, or set in this code.
+ *      stats->robustN50
+ *      stats->clippedNvalues
+ *      stats->binsize
  *
- *  @version $Revision: 1.40 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-03-29 22:34:59 $
+ *  @author GLG, MHPCC
+ *
+ *  @version $Revision: 1.41 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-07 23:11:54 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -67 +71 @@
     psF64 robustUQ;            ///< robust upper quartile
     psF64 robustLQ;            ///< robust lower quartile
-    psS32 robustN50;              ///<
-    psS32 robustNfit;             ///<
+    psS32 robustN50;           ///< Number of points in Gaussian fit.  XXX: This is currently never set.
+    psS32 robustNfit;          ///< The number of points between the quartiles.
     psF64 clippedMean;         ///< Nsigma clipped mean
     psF64 clippedStdev;        ///< standard deviation after clipping
-    psS32 clippedNvalues;         ///< ???
+    psS32 clippedNvalues;      ///< Number of data points used for clipped mean:  This value is never used.
     psF64 clipSigma;           ///< Nsigma used for clipping; user input
-    psS32 clipIter;               ///< Number of clipping iterations; user input
+    psS32 clipIter;            ///< Number of clipping iterations; user input
     psF64 min;                 ///< minimum data value in array
     psF64 max;                 ///< maximum data value in array
-    psF64 binsize;             ///<
-    psStatsOptions options;     ///< bitmask of calculated values
+    psF64 binsize;             ///< binsize for robust fit (input/ouput)
+    psStatsOptions options;    ///< bitmask of calculated values
 }
 psStats;
@@ -86 +90 @@
  */
 psStats* psVectorStats(
-    psStats* stats,    ///< stats structure defines stats to be calculated and how
+    psStats* stats,          ///< stats structure defines stats to be calculated and how
     const psVector* in,      ///< Vector to be analysed.
     const psVector* errors,  ///< Errors.
     const psVector* mask,    ///< Ignore elements where (maskVector & maskVal) != 0: must be INT or NULL
-    psU32 maskVal      ///< Only mask elements with one of these bits set in maskVector
+    psU32 maskVal            ///< Only mask elements with one of these bits set in maskVector
 );
 
@@ -119 +123 @@
     psVector* bounds;                  ///< Bounds for the bins (type F32)
     psVector* nums;                    ///< Number in each of the bins (INT)
-    psS32 minNum;                        ///< Number below the minimum
-    psS32 maxNum;                        ///< Number above the maximum
-    psBool uniform;                      ///< Is it a uniform distribution?
+    psS32 minNum;                      ///< Number below the minimum
+    psS32 maxNum;                      ///< Number above the maximum
+    psBool uniform;                    ///< Is it a uniform distribution?
 }
 psHistogram;
@@ -134 +138 @@
     psF32 lower,                       ///< Lower limit for the bins
     psF32 upper,                       ///< Upper limit for the bins
-    psS32 n                              ///< Number of bins
+    psS32 n                            ///< Number of bins
 );
 
@@ -165 +169 @@
  *
  *  @return psBool    If more than one statistic result is set in stats->options,
- *                  false is returned and the value parameter is not set, 
- *                  otherwise true is returned.
+ *                    false is returned and the value parameter is not set, 
+ *                    otherwise true is returned.
  */
 psBool p_psGetStatValue(
-    const psStats* stats,
-    ///< the statistic struct to operate on
+    const psStats* stats, ///< the statistic struct to operate on
 
-    psF64 *value
-    ///< if return is true, this is set to the specified statistic value by stats->options
+    psF64 *value ///< if return is true, this is set to the specified statistic value by stats->options
 );
 
+// XXX: Create a single, generic, version of the vector normalize function.
+// XXX: Ask IfA for a public psLib function.
 void p_psNormalizeVectorRangeU8(psVector* myData, psU8 low, psU8 high);
 void p_psNormalizeVectorRangeU16(psVector* myData, psU16 low, psU16 high);