Index: trunk/psLib/src/math/psStats.h =================================================================== --- trunk/psLib/src/math/psStats.h (revision 1406) +++ trunk/psLib/src/math/psStats.h (revision 1407) @@ -1,2 +1,3 @@ + /** @file psStats.h * \brief basic statistical operations @@ -9,13 +10,13 @@ * @author George Gusciora, MHPCC * - * @version $Revision: 1.20 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-08-06 22:34:05 $ + * @version $Revision: 1.21 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-08-07 00:06:06 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ #if !defined(PS_STATS_H) -#define PS_STATS_H +# define PS_STATS_H -#include "psVector.h" +# include "psVector.h" /// @addtogroup Stats @@ -26,22 +27,21 @@ *****************************************************************************/ typedef enum { - PS_STAT_SAMPLE_MEAN = 0x000001, - PS_STAT_SAMPLE_MEDIAN = 0x000002, - PS_STAT_SAMPLE_STDEV = 0x000004, - PS_STAT_SAMPLE_QUARTILE = 0x000008, - PS_STAT_ROBUST_MEAN = 0x000010, - PS_STAT_ROBUST_MEDIAN = 0x000020, - PS_STAT_ROBUST_MODE = 0x000040, - PS_STAT_ROBUST_STDEV = 0x000080, - PS_STAT_ROBUST_QUARTILE = 0x000100, - 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_USE_BINSIZE = 0x004000, - PS_STAT_ROBUST_FOR_SAMPLE = 0x008000 + PS_STAT_SAMPLE_MEAN = 0x000001, + PS_STAT_SAMPLE_MEDIAN = 0x000002, + PS_STAT_SAMPLE_STDEV = 0x000004, + PS_STAT_SAMPLE_QUARTILE = 0x000008, + PS_STAT_ROBUST_MEAN = 0x000010, + PS_STAT_ROBUST_MEDIAN = 0x000020, + PS_STAT_ROBUST_MODE = 0x000040, + PS_STAT_ROBUST_STDEV = 0x000080, + PS_STAT_ROBUST_QUARTILE = 0x000100, + 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_USE_BINSIZE = 0x004000, + PS_STAT_ROBUST_FOR_SAMPLE = 0x008000 } psStatsOptions; - /** This is the generic statistics structure. It contails the data members @@ -50,80 +50,74 @@ typedef struct { - double sampleMean; ///< formal mean of sample - double sampleMedian; ///< formal median of sample - double sampleStdev; ///< standard deviation of sample - 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 - double robustMode; ///< Robust mode of array - double robustStdev; ///< robust standard deviation of array - double robustUQ; ///< robust upper quartile - double robustLQ; ///< robust lower quartile + double sampleMean; // /< formal mean of sample + double sampleMedian; // /< formal median of sample + double sampleStdev; // /< standard deviation of sample + 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 + double robustMode; // /< Robust mode of array + double robustStdev; // /< robust standard deviation of array + 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 - double clipSigma; ///< Nsigma used for clipping; user input - int clipIter; ///< Number of clipping iterations; user input - double min; ///< minimum data value in array - double max; ///< maximum data value in array - double binsize; ///< - psStatsOptions options; ///< bitmask of calculated values + double robustN50; // /< + double robustNfit; // /< + double clippedMean; // /< Nsigma clipped mean + double clippedStdev; // /< standard deviation after clipping + double clipSigma; // /< Nsigma used for clipping; user input + int clipIter; // /< Number of clipping iterations; user input + double min; // /< minimum data value in array + double max; // /< maximum data value in array + double binsize; // /< + psStatsOptions options; // /< bitmask of calculated values } psStats; - /** Do Statistics on an array. Returns a status value. \ingroup MathGroup */ -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 *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 + ); /** A constructor for the stats structure.*/ -psStats *psStatsAlloc(psStatsOptions options); ///< Statistics to measure +psStats *psStatsAlloc(psStatsOptions options); // /< Statistics to measure /****************************************************************************** Histogram functions and data structures. *****************************************************************************/ + /** The basic histogram structure which contains bounds and bins. */ typedef struct { - psVector *bounds; ///< Bounds for the bins (type F32) - psVector *nums; ///< Number in each of the bins (INT) - int minNum; ///< Number below the minimum - int maxNum; ///< Number above the maximum - bool uniform; ///< Is it a uniform distribution? + psVector *bounds; // /< Bounds for the bins (type F32) + psVector *nums; // /< Number in each of the bins (INT) + int minNum; // /< Number below the minimum + int maxNum; // /< Number above the maximum + bool uniform; // /< Is it a uniform distribution? } psHistogram; - /** Constructor \ingroup MathGroup */ -psHistogram * -psHistogramAlloc(float lower, ///< Lower limit for the bins - float upper, ///< Upper limit for the bins - int n); ///< Number of bins - +psHistogram *psHistogramAlloc(float lower, // /< Lower limit for the bins + float upper, // /< Upper limit for the bins + int n); // /< Number of bins /** Generic constructor \ingroup MathGroup */ -psHistogram * psHistogramAllocGeneric(const psVector *restrict bounds); ///< Bounds for the bins +psHistogram *psHistogramAllocGeneric(const psVector * restrict bounds); // /< Bounds for the bins /** Calculate a histogram \ingroup MathGroup **/ -psHistogram *psVectorHistogram (psHistogram *out, ///< Histogram data - const psVector *restrict in, ///< Vector to analyse - const psVector *restrict mask, ///< Mask dat for input vector - unsigned int maskVal); ///< Mask value +psHistogram *psVectorHistogram(psHistogram * out, // /< Histogram data + const psVector * restrict in, // /< Vector to analyse + const psVector * restrict mask, // /< Mask dat for input vector + unsigned int maskVal); // /< Mask value -bool p_psGetStatValue( - const psStats* stats, - double* value -); +bool p_psGetStatValue(const psStats * stats, double *value); /// @} #endif -