IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Aug 9, 2004, 12:44:25 PM (22 years ago)
Author:
desonia
Message:

fixed some stupid indent-induced formating problems and added doxygen
comments.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/psLib/src/dataManip/psStats.h

    r1407 r1426  
    1010 *  @author George Gusciora, MHPCC
    1111 *
    12  *  @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-08-07 00:06:06 $
     12 *  @version $Revision: 1.22 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2004-08-09 22:44:25 $
    1414 *
    1515 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    5050typedef struct
    5151{
    52     double sampleMean;          // /< formal mean of sample
    53     double sampleMedian;        // /< formal median of sample
    54     double sampleStdev;         // /< standard deviation of sample
    55     double sampleUQ;            // /< upper quartile of sample
    56     double sampleLQ;            // /< lower quartile of sample
    57     double sampleLimit;         // /<
    58     double robustMean;          // /< robust mean of array
    59     double robustMedian;        // /< robust median of array
    60     double robustMode;          // /< Robust mode of array
    61     double robustStdev;         // /< robust standard deviation of array
    62     double robustUQ;            // /< robust upper quartile
    63     double robustLQ;            // /< robust lower quartile
     52    double sampleMean;          ///< formal mean of sample
     53    double sampleMedian;        ///< formal median of sample
     54    double sampleStdev;         ///< standard deviation of sample
     55    double sampleUQ;            ///< upper quartile of sample
     56    double sampleLQ;            ///< lower quartile of sample
     57    double sampleLimit;         ///<
     58    double robustMean;          ///< robust mean of array
     59    double robustMedian;        ///< robust median of array
     60    double robustMode;          ///< Robust mode of array
     61    double robustStdev;         ///< robust standard deviation of array
     62    double robustUQ;            ///< robust upper quartile
     63    double robustLQ;            ///< robust lower quartile
    6464    double XXX;
    65     double robustN50;           // /<
    66     double robustNfit;          // /<
    67     double clippedMean;         // /< Nsigma clipped mean
    68     double clippedStdev;        // /< standard deviation after clipping
    69     double clipSigma;           // /< Nsigma used for clipping; user input
    70     int clipIter;               // /< Number of clipping iterations; user input
    71     double min;                 // /< minimum data value in array
    72     double max;                 // /< maximum data value in array
    73     double binsize;             // /<
    74     psStatsOptions options;     // /< bitmask of calculated values
     65    double robustN50;           ///<
     66    double robustNfit;          ///<
     67    double clippedMean;         ///< Nsigma clipped mean
     68    double clippedStdev;        ///< standard deviation after clipping
     69    double clipSigma;           ///< Nsigma used for clipping; user input
     70    int clipIter;               ///< Number of clipping iterations; user input
     71    double min;                 ///< minimum data value in array
     72    double max;                 ///< maximum data value in array
     73    double binsize;             ///<
     74    psStatsOptions options;     ///< bitmask of calculated values
    7575}
    7676psStats;
    7777
    7878/** Do Statistics on an array.  Returns a status value. \ingroup MathGroup */
    79 psStats *psVectorStats(psStats * stats, // /< stats structure defines stats to be calculated and how
    80                        psVector * in,   // /< Vector to be analysed: must be F32
    81                        psVector * mask, // /< Ignore elements where (maskVector & maskVal) != 0: must be INT
     79psStats *psVectorStats(psStats * stats, ///< stats structure defines stats to be calculated and how
     80                       psVector * in,   ///< Vector to be analysed: must be F32
     81                       psVector * mask, ///< Ignore elements where (maskVector & maskVal) != 0: must be INT
    8282                       // or NULL
    83                        unsigned int maskVal     // /< Only mask elements with one of these bits set in
     83                       unsigned int maskVal     ///< Only mask elements with one of these bits set in
    8484                       // maskVector
    8585                      );
    8686
    8787/** A constructor for the stats structure.*/
    88 psStats *psStatsAlloc(psStatsOptions options);  // /< Statistics to measure
     88psStats *psStatsAlloc(psStatsOptions options);  ///< Statistics to measure
    8989
    9090/******************************************************************************
     
    9595typedef struct
    9696{
    97     psVector *bounds;           // /< Bounds for the bins (type F32)
    98     psVector *nums;             // /< Number in each of the bins (INT)
    99     int minNum;                 // /< Number below the minimum
    100     int maxNum;                 // /< Number above the maximum
    101     bool uniform;               // /< Is it a uniform distribution?
     97    psVector *bounds;           ///< Bounds for the bins (type F32)
     98    psVector *nums;             ///< Number in each of the bins (INT)
     99    int minNum;                 ///< Number below the minimum
     100    int maxNum;                 ///< Number above the maximum
     101    bool uniform;               ///< Is it a uniform distribution?
    102102}
    103103psHistogram;
    104104
    105105/** Constructor \ingroup MathGroup */
    106 psHistogram *psHistogramAlloc(float lower,      // /< Lower limit for the bins
    107                               float upper,      // /< Upper limit for the bins
    108                               int n);   // /< Number of bins
     106psHistogram *psHistogramAlloc(float lower,      ///< Lower limit for the bins
     107                              float upper,      ///< Upper limit for the bins
     108                              int n);   ///< Number of bins
    109109
    110110/** Generic constructor \ingroup MathGroup */
    111 psHistogram *psHistogramAllocGeneric(const psVector * restrict bounds); // /< Bounds for the bins
     111psHistogram *psHistogramAllocGeneric(const psVector * restrict bounds); ///< Bounds for the bins
    112112
    113113/** Calculate a histogram \ingroup MathGroup **/
    114 psHistogram *psVectorHistogram(psHistogram * out,       // /< Histogram data
    115                                const psVector * restrict in,    // /< Vector to analyse
    116                                const psVector * restrict mask,  // /< Mask dat for input vector
    117                                unsigned int maskVal);   // /< Mask value
     114psHistogram *psVectorHistogram(psHistogram * out,       ///< Histogram data
     115                               const psVector * restrict in,    ///< Vector to analyse
     116                               const psVector * restrict mask,  ///< Mask dat for input vector
     117                               unsigned int maskVal);   ///< Mask value
    118118
    119119bool p_psGetStatValue(const psStats * stats, double *value);
Note: See TracChangeset for help on using the changeset viewer.